id
stringlengths 12
53
| messages
listlengths 3
3
|
|---|---|
doc_f0e29f13
|
[
{
"role": "system",
"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 builders 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-builders/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-builders/docs/api-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-builders/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-builders/docs/storefront-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-builders/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-builders/docs/troubleshooting)\n\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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/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-builders/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-builders/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-builders/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-builders/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/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-builders/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/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-builders/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-builders/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-builders/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-builders/docs/app-development)\n\nProject structure\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/guides/vtex-io-documentation-builders)\n\nBuilders\n\nLearn what VTEX IO Builders are and how to use them.\n\nBuilders play a pivotal role in streamlining app development. They are the orchestrators of VTEX IO apps, responsible for processing, validating, and passing on a specific block of code to a runtime or framework capable of executing it. This article will teach you what Builders are and how to use them effectively.\n\n## Understanding Builders\n\nIn practical terms, a Builder acts like a bridge that allows different parts of your app to work together by configuring and connecting to the necessary services. Each Builder operates under its unique set of rules and validation processes, acting as gateways to an IO app's functionalities.\n\nBy having very well-defined and minimal responsibilities, a Builder can evolve independently, allowing for rapid development with minimal disruptive changes.\n\n## Using Builders\n\nBuilders are specified in an app's `manifest.json` file, and the app itself is neatly structured with folders bearing the Builder's names. This organization ensures that each Builder knows precisely which code to process.\n\n\n\nWhen you run a VTEX IO app, each Builder converts the files included in its corresponding folder into configurations for the competent services. This means an app can have as many Builders as you want, enabling the bundling of both frontend and backend development into a single package.\n\nFor more information on the available Builders, see the [List of Builders](#list-of-builders) section.\n\n> To use Builders, ensure that you have at least `vtex.builder-hub@0.293.4` version [installed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-usage%23installing-an-app) in your account.\n\n## Example\n\nSuppose you want to develop a React frontend component with VTEX IO. For this, you will need to use a Builder that offers a React renderer, namely, the `react` Builder. To do that, you must declare the `react` Builder in your app's `manifest.json` file, as in the following:\n\n`1\n\n\"builders\": { \n\n2\n\n \"react\": \"3.x\" \n\n3\n\n} \n\n`\n\nThen, in your app's root directory, you must create a folder named after the Builder (e.g., `/react`) and place your React code inside it.\n\nWhen you run your app, the `react` Builder will transform the React code within the `/react` folder into compiled bundles, ready to be imported into frontend apps.\n\n## List of Builders\n\nThis is a non-exhaustive list of VTEX IO Builders:\n\n| Name | Functionality |\n| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| admin | Exports blocks and routes to the VTEX Admin. |\n| assets | Handles assets used by Store Theme blocks. It gets all asset paths used and uploads them to the VTEX IO database. For more information, refer to the [Using the Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-assets-builder/) guide. |\n| configuration | Allows you to allocate code pertaining to service configurations to an app that's independent of the platform. For more information, refer to the [Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/) guide. |\n| docs | Allows developers to add documentation in the /docs directory, to be published in our Developer Portal. For more information, refer to the [Using the Docs Builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-docs-builder-to-publish-app-documentation/) guide. |\n| dotnet | Interprets the /dotnet directory, empowering the development of custom backend services. |\n| graphql | Processes GraphQL API's and schemas by interpreting .graphql and .gql files contained in the app's /graphql directory. |\n| services | Fetches service workers exported by the account's installed apps and bundles them in a single file, enabling the store to work with several service workers simultaneously. You can learn how to use it by accessing the recipe on [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). |\n| styles | Exports CSS configurations for Store Framework blocks. When building your app, the Styles Builder reads the styles/styles.json file and uses a [Tachyons](https://read.calvincode.net/reader?url=https://tachyons.io/) generator to properly produce your store's CSS. |\n| store | Interprets and validates the blocks, interfaces, and routes contained in the theme app's /store directory, powering [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework) store's components and building the storefront. |\n| messages | Exports localized string messages, empowering _VTEX IO internationalization_. It reads .json files associated with different locales within the app's /messages directory and makes them available for frontend applications to use via react-intl. |\n| masterdata | Allows declaration of the data entities used in the app with [JSON schema](https://read.calvincode.net/reader?url=https://json-schema.org/) format. You can define the complete data entity structure and behavior, including field rules, triggers, and indexing. For more information, refer to [Creating a Master Data v2 CRUD app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app). |\n| node | Interprets the /node directory, empowering the development of custom backend services using TypeScript. For more information, refer to the [Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service) guides. |\n| paymentProvider | Allows the implementation of payment connectors using the [Payment Provider Framework (PPF)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework). The framework natively provides access to the [Payment Provider Protocol (PPP) API endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol) within predefined classes. The framework also allows the configuration of [payment methods](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-configure-payment-conditions--tutorials%5F455) and uses the [Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy) for card transactions. |\n| pixel | Processes the source-code and configuration of [Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pixel-apps) in VTEX IO. The files picked up by this Builder are located in the app's /pixel directory. For more information, refer to the [Developing Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps) guide. |\n| react | Interprets the /react directory, empowering the development of React components using TypeScript. For more information, refer to the [Developing frontend apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io) guide. |\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-builders.md)\n\n[Billing Options« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders//docs/guides/vtex-io-documentation-billing-options)[Admin BuilderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders//docs/guides/vtex-io-documentation-admin-builder)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Understanding Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/guides/vtex-io-documentation-builders%23understanding-builders)\n\n[Using Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/guides/vtex-io-documentation-builders%23using-builders)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/guides/vtex-io-documentation-builders%23example)\n\n[List of Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/guides/vtex-io-documentation-builders%23list-of-builders)\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.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Understanding Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/guides/vtex-io-documentation-builders%23understanding-builders)\n\n[Using Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/guides/vtex-io-documentation-builders%23using-builders)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/guides/vtex-io-documentation-builders%23example)\n\n[List of Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/docs/guides/vtex-io-documentation-builders%23list-of-builders)\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_fc41d16b
|
[
{
"role": "system",
"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 vtex release cli command returns ebadf message 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/vtex-release-cli-command-returns-ebadf-message/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/api-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/vtex-release-cli-command-returns-ebadf-message/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/vtex-release-cli-command-returns-ebadf-message/docs/storefront-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/vtex-release-cli-command-returns-ebadf-message/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/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting)\n\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/vtex-release-cli-command-returns-ebadf-message/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting)\n\nDevelopment\n\n`vtex release` CLI command returns an EBADF message\n\nCreating an app release using the VTEX IO CLI returns an EBADF error.\n\n**Keywords:** Release | CLI\n\nWhen running the [VTEX IO CLI command vtex release](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference%23release), it returns an EBADF (error bad file descriptor) message. This happens because a file descriptor variable does not correctly point to a file during command execution.\n\nThe `vtex release` command creates a new version of a VTEX IO app by rewriting the `CHANGELOG.md` and the `manifest.json` files. For more details about this process, see [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\nThe `vtex release` command creates a release commit and a release tag and sends the changes to the app repository. Thus, a possible cause of the EBADF message could be improper GitHub configuration. For more details, see the [external GitHub documentation](https://read.calvincode.net/reader?url=https://docs.github.com/en/enterprise-cloud@latest/get-started/getting-started-with-git/set-up-git%23setting-up-git).\n\n## Solution\n\nInstead of depending on the `vtex release` command to make the changes in the app files for a new version, make the changes manually and continue [deploying a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available).\n\nConsider your app was at version `0.1.0` and a new version `0.1.1` was created on July 15, 2024\\. Follow the steps below to create a new app version without using the `vtex release` command:\n\n1. Open the `CHANGELOG.md` file of your app.\n2. Update the version header from `## [Unreleased]` to `## [0.1.1] - 2024-07-15`, as follows: \n`1 \n- ## [Unreleased] \n2 \n+ ## [0.1.1] - 2024-07-15 \n3 \n+ \n4 \n+ ### Added \n5 \n+ \n6 \n+ * New feature \n7 \n \n8 \n## [0.1.0] - 2024-06-03 \n9 \n \n10 \n### Fixed \n11 \n \n12 \n* Bug fixes \n`\n3. Open the `manifest.json` file of your app and change the app version to the new version. In this example, we are changing the version from `0.1.0` to `0.1.1`. \n`1 \n\"version\": “0.1.1” \n`\n4. Open a terminal in the root folder of your app.\n5. Run the [vtex publish command](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference%23publish). This command creates a release candidate version of the app and makes it available for installation using the [vtex install command](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference%23install). For more details, see [Publishing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app).\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\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/troubleshooting/development/vtex-release-cli-command-returns-ebadf-message.md)\n\n[The promotion highlight flag does not appear on the product« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)[I can't create a new workspaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/i-cant-create-a-new-workspace)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message%23solution)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/vtex-release-cli-command-returns-ebadf-message.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message%23solution)\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_5749c6a0
|
[
{
"role": "system",
"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 the integration protocol between vtex and antifraud companies works 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-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/api-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-the-integration-protocol-between-vtex-and-antifraud-companies-works/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-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/storefront-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-the-integration-protocol-between-vtex-and-antifraud-companies-works/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-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/troubleshooting)\n\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-the-integration-protocol-between-vtex-and-antifraud-companies-works/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/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/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/payments-integration-guide)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n\nHow the integration protocol between VTEX and antifraud companies works\n\nThe Anti-fraud Provider Protocol is the integration protocol between VTEX and companies that provide anti-fraud services.\n\nThrough it, VTEX offers a public contract available to all providers that wish to integrate into our platform. As a result, providers become more autonomous regarding such integration.\n\nThe protocol has the following features:\n\n* Processing of synchronous and asynchronous risk analysis.\n* Webhook for status notification.\n\n> The Anti-fraud Provider Protocol can be used at VTEX only for payment transactions carried out with credit, [debit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions), and gift cards.\n\n## Concepts\n\n**Provider**: system or provider that offers the anti-fraud risk analysis service.\n\n**Anti-fraud Provider Protocol**: integration protocol developed by VTEX.\n\n**Connector**: name of the integration partner provider.\n\n## Implementation prerequisites\n\n### 1\\. Business partnership agreement\n\nTo make your anti-fraud service available at VTEX, you must sign a partnership agreement that is specific to financial services covering the details of this subject and platform regulations. If you do not have a partnership agreement yet but are interested in becoming a payment provider, contact our team through our [website](https://read.calvincode.net/reader?url=https://vtex.com/us-en/partner).\n\n### 2\\. Access to a VTEX environment\n\nAfter obtaining a business partnership agreement with VTEX, you will receive all information to access the VTEX environment, where you can publish, homologate, update, and have access to our support when developing and maintaining a connector.\n\nIf the partner is a SI (Service Implementer) developing integrations for clients or other payment providers, the VTEX account of the main provider must be used and not the account of the contractor agency.\n\n## Integration steps\n\n### 1\\. Implementing the protocol\n\nBefore setting up the VTEX environment, the provider must implement the backend service required to process the anti-fraud services (API). For more information, access the [Anti-fraud Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol).\n\n> You can also access our [template on GitHub](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\n\n### 2\\. Install the Anti-fraud Provider Tester App\n\nAfter receiving the access data and deploying the backend, the provider can access the approval tool through VTEX Admin. If you still do not have the Anti-fraud Provider Tester App installed in your store, you need to follow these steps:\n\n1. In the VTEX Admin, go to **Apps > Apps Store**.\n2. Type **Antifraud Provider** in the search bar at the bottom of the page and click on `Install`.\n3. After that, you will be redirected to the VTEX APP Store. Click the `GET APP` button at the top right corner of the page.\n4. Then, on the popup screen, type your account's name (with lowercase and no space in between) and click the `CONFIRM` button.\n5. Click `INSTALL` to complete the installation process. \n\n\nWith the app installed, go to **Apps > Installed Apps** and click on **Antifraud Provider**, or access `https://{{AccountName}}.myvtex.com/admin/test-suite/antifraud-provider`, replacing `{{AccountName}}` with the name of your platform account.\n\n### 3\\. Initial settings\n\nIn the Anti-fraud Provider Tester app environment, fill in the fields as indicated below:\n\n* **Connector Name**: name you want to give to your connector within VTEX.\n* **Service URL**: URL of your provider service. This URL will be the base address of the protocol and must follow the format determined by it. For example, if the service URL is `http://10.10.10.10`, the full URL for the endpoint _transactions_ will be `http://10.10.10.10/transactions`.\n* **API key**: \"X-PROVIDER-API-AppKey\" value of your provider's request header for testing purposes.\n* **API token**: \"X-PROVIDER-API-AppToken\" value of your provider's request header for testing purposes.\n\n\n\n> It is important to remember that all HTTPS communication should run exclusively on TLS 1.2\\. Your provider must be prepared to receive two headers (**X-PROVIDER-API-AppKey** and **X-PROVIDER-API-AppToken**), as this combination is used to identify a merchant. All settings that need to be made by the merchant should persist in your provider. The only configuration that VTEX saves about merchants is the combination of X-PROVIDER-API-AppKey and X-PROVIDER-API-AppToken credentials.\n\nAfter completing the fields correctly, the system will check the approved transactions through a call to the _**/transactions**_ endpoint of your provider. See the API reference [here](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23post-/transactions).\n\n### 4\\. Testing\n\nTo ensure the correct operation of the anti-fraud, a series of tests are necessary. You can choose how many tests you want to run at a time. However, for your integration to be analyzed by the VTEX team, **all tests must have been performed and approved**. See below the description of each test:\n\n* **Authorize**: test performed in two steps. \n * A [Send Anti-fraud Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23post-/transactions) request (`{{ServiceURL}}/transactions`) is sent. The expected value for `status` in the response body is `received`. \n * A [Get Anti-fraud Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/transactions/-transactions.id-) request (`{{ServiceURL}}/transactions/transactionId`), with the Transaction ID generated in the previous step, is sent. The expected value for `status` in the response body is `approved`.\n* **Denied**: test performed in two steps. \n * A [Send Anti-fraud Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23post-/transactions) request (`{{ServiceURL}}/transactions`) is sent. The expected value for `status` in the response body is `received`. \n * A [Get Anti-fraud Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/transactions/-transactions.id-) request (`{{ServiceURL}}/transactions/transactionId`), with the Transaction ID generated in the previous step, is sent. The expected value for `status` in the response body is `denied`.\n* **AsyncApproved**: test performed in three steps. \n * A [Send Anti-fraud Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23post-/transactions) request (`{{ServiceURL}}/transactions`) is sent. The expected value for `status` in the response body is `received`. \n * A [Get Anti-fraud Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/transactions/-transactions.id-) request (`{{ServiceURL}}/transactions/transactionId`), with the Transaction ID generated in the previous step, is sent. The expected value for `status` in the response body is `undefined`. \n * After 10 seconds, a [Get Anti-fraud Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/transactions/-transactions.id-) request (`{{ServiceURL}}/transactions/transactionId`), with the Transaction ID generated in the first step, is sent again. The expected value for `status` in the response body is `approved`.\n* **AsyncDenied**: test performed in three steps. \n * A [Send Anti-fraud Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23post-/transactions) request (`{{ServiceURL}}/transactions`) is sent. The expected value for `status` in the response body is `received`. \n * A [Get Anti-fraud Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/transactions/-transactions.id-) request (`{{ServiceURL}}/transactions/transactionId`), with the Transaction ID generated in the previous step, is sent. The expected value for `status` in the response body is `undefined`. \n * After 10 seconds, a [Get Anti-fraud Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/transactions/-transactions.id-) request (`{{ServiceURL}}/transactions/transactionId`), with the Transaction ID generated in the first step, is sent again. The expected value for `status` in the response body is `denied`.\n* **HookApproved**: test performed in four steps. \n * A [Send Anti-fraud Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23post-/transactions) request (`{{ServiceURL}}/transactions`) is sent. The expected value for `status` in the response body is `received`. \n * A [Get Anti-fraud Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/transactions/-transactions.id-) request (`{{ServiceURL}}/transactions/transactionId`), with the Transaction ID generated in the previous step, is sent. The expected value for `status` in the response body is `undefined`. \n * Afterwards, 10 seconds is waited for the anti-fraud provider to POST the URL sent in the _hook_ field of the first step (the POST content should contain the response obtained in that same step). \n * A [Get Anti-fraud Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/transactions/-transactions.id-) request (`{{ServiceURL}}/transactions/transactionId`), with the Transaction ID generated in the first step, is sent again. The expected value for `status` in the response body is `approved`.\n* **HookDenied**: test performed in four steps. \n * A [Send Anti-fraud Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23post-/transactions) request (`{{ServiceURL}}/transactions`) is sent. The expected value for `status` in the response body is `received`. \n * A [Get Anti-fraud Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/transactions/-transactions.id-) request (`{{ServiceURL}}/transactions/transactionId`), with the Transaction ID generated in the previous step, is sent. The expected value for `status` in the response body is `undefined`. \n * Afterwards, 10 seconds is waited for the anti-fraud provider to POST the URL sent in the _hook_ field of the first step (the POST content should contain the response obtained in that same step). \n * A [Get Anti-fraud Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/transactions/-transactions.id-) request (`{{ServiceURL}}/transactions/transactionId`), with the Transaction ID generated in the first step, is sent again. The expected value for `status` in the response body is `denied`.\n\nWhen you click the **RUN TESTS** button, the Anti-fraud Provider Tester App will apply the selected tests in your integration to the different possible scenarios. To run them your service must be in HTTPS.\n\n\n\nFor each Anti-fraud Provider Protocol test, we send a specific ID end to return the expected response. They are:\n\n* **Authorize**: ID with end 1.\n* **Denied**: ID with end 2.\n* **AsyncApproved**: ID with end 3.\n* **AsyncDenied**: ID with end 4.\n* **HookApproved**: ID with end 5.\n* **HookDenied**: ID with end 6.\n\n### 5\\. Results\n\nAfter executing the tests, all results (successes or failures) will be displayed in the app environment.\n\nA list with detailed information about the events that occurred during the tests can be accessed by clicking on **Show logs**. This will allow identifying and correcting possible errors, in case of test failure.\n\n\n\n\n\nWhen your integration has successfully passed all tests, please open a ticket in our [VTEX support](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/support). However, before opening the ticket, make sure you have the following information available: \n* **Connector Name**: a description of the provider. Use max. 16 alphanumeric characters. This name can not be modified after being published.\n* **Partner contact**: partner's email address. We will use this address to communicate changes and new features of our protocol.\n* **Production Service Provider Endpoint**: the base path that will be used for API calls to the provider (e.g., `https://vtex.pagseguro.com`). It has to respond to the route `{{serviceUrl}}/manifest`. This endpoint must be publicly available.\n* **Sandbox Service Provider Endpoint**: the base path that will be used in test mode for API calls to the provider (e.g., `https://sandboxserviceproviderendpoint.com`).\n* **Owner account**: the VTEX account name which will be used in callback requests. This account must be available at _{account}.myvtex.com_.\n* **Allowed Accounts**: describe which VTEX accounts from this provider will be available (all accounts or specific accounts).\n* **New Payment methods**: inform if this connector supports a payment method that is not yet available in the VTEX Admin.\n* **New Payment method purchase flow**: if a “New Payment method” is supported, inform whether it works with Redirect or Payment App. For more information, access [Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows).\n\nThe SLA required for the VTEX payments team to carry out the homologation is 30 days.\n\n> VTEX Antifraud provider protocol supports payment transactions carried out using credit, debit, and gift cards. If you want to allow gift card payment transactions in your anti-fraud provider, set the `allowAntifraudOnGiftCard` field to `true` in the manifest.\n\n## VTEX Credentials\n\nWhen calling `CallbackURL`, you must specify the authentication headers, which in VTEX are **X-VTEX-API-AppKey** and **X-VTEX-API-AppToken**. You can find these credentials in VTEX License Manager. These credentials are used by the Anti-fraud Provider only.\n\nUse the `https://{{AccountName}}.myvtex.com/admin/license-manager/#/home` URL, replacing `{{AccountName}}` with your account name. Then follow the instructions of [this tutorial](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6) to learn how to create appKeys and appTokens on our platform.\n\n## Settings in VTEX stores\n\nOnce the integration with your anti-fraud is approved, a connector will be made available for VTEX merchants to configure it on their respective stores. To do this, in addition to the contract with your company, the store will need two keys in hand: \"X-PROVIDER-API-AppKey\" and \"X-PROVIDER-API-AppToken\".\n\nAn example of how the anti-fraud settings screen will look for the VTEX store:\n\n\n\nThese keys should be made available by you and will serve to identify the store that hired and is using your anti-fraud service. \n\n## Cardholder Document Configuration\n\nDuring payment transactions analysis, some anti-fraud providers may choose not to use additional information such as the cardholder’s personal identification. In these cases, the merchant has the autonomy to decide whether or not to request this document from his customer during the checkout procedure.\n\n> The configuration option **Cardholder document field** will only be available to the merchant if the anti-fraud provider declares in its [manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23get-/manifest), the cardholder document field (`cardholderDocument`) as `optional`. Learn more at [Cardholder Document Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration).\n\nTo set up the cardholder document field, follow the steps below:\n\n1. In the VTEX Admin, go to **Store Settings > Payments > Settings**, or type **Settings** in the search bar at the top of the page.\n2. In the **Gateway affiliations** tab, click on the `+` button.\n3. Select the anti-fraud provider you wish to use.\n4. On the anti-fraud configuration screen, fill in the requested information.\n5. In **Cardholder document field**, select one of the following options: \n * **Display as a required field**: the field will be displayed at checkout with the information “required”, and the customer must fill in the cardholder information to complete the order. \n * **Display as an optional field**: the field will be displayed at checkout with the information “optional”, and the customer will decide whether or not to fill in it. The order can be completed even if the field is not filled in. \n * **Hide Field**: the field will not be displayed at checkout.\n6. Click on **Save**.\n\nAfter following the steps indicated, the settings made above may take up to 10 minutes to appear at your store's checkout.\n\nContributors\n\n4\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/how-the-integration-protocol-between-vtex-and-antifraud-companies-works.md)\n\n[Payment Provider Homologation« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works//docs/guides/payments-integration-payment-provider-homologation)[PCI - DSS ComplianceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works//docs/guides/payments-integration-pci-dss-compliance)\n\nContributors\n\n4\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23concepts)\n\n[Implementation prerequisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23implementation-prerequisites)\n\n[1\\. Business partnership agreement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%231-business-partnership-agreement)[2\\. Access to a VTEX environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%232-access-to-a-vtex-environment)\n\n[Integration steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23integration-steps)\n\n[1\\. Implementing the protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%231-implementing-the-protocol)[2\\. Install the Anti-fraud Provider Tester App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%232-install-the-anti-fraud-provider-tester-app)[3\\. Initial settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%233-initial-settings)[4\\. Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%234-testing)[5\\. Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%235-results)\n\n[VTEX Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23vtex-credentials)\n\n[Settings in VTEX stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23settings-in-vtex-stores)\n\n[Cardholder Document Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23cardholder-document-configuration)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/how-the-integration-protocol-between-vtex-and-antifraud-companies-works.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23concepts)\n\n[Implementation prerequisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23implementation-prerequisites)\n\n[1\\. Business partnership agreement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%231-business-partnership-agreement)[2\\. Access to a VTEX environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%232-access-to-a-vtex-environment)\n\n[Integration steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23integration-steps)\n\n[1\\. Implementing the protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%231-implementing-the-protocol)[2\\. Install the Anti-fraud Provider Tester App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%232-install-the-anti-fraud-provider-tester-app)[3\\. Initial settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%233-initial-settings)[4\\. Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%234-testing)[5\\. Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%235-results)\n\n[VTEX Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23vtex-credentials)\n\n[Settings in VTEX stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23settings-in-vtex-stores)\n\n[Cardholder Document Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works%23cardholder-document-configuration)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_fa6cd966
|
[
{
"role": "system",
"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 enabling order form optimization 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-enabling-order-form-optimization/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-enabling-order-form-optimization/docs/api-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-enabling-order-form-optimization/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-enabling-order-form-optimization/docs/storefront-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-enabling-order-form-optimization/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-enabling-order-form-optimization/docs/troubleshooting)\n\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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/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-enabling-order-form-optimization/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/store-framework)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/store-framework-managing-performance)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\nEnabling the orderForm optimization\n\nThe [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) object is central to every VTEX store, managing and fetching order data such as the items added to a customer's cart. This data enables store blocks to display and interact with the shopping cart and checkout information.\n\nTo manage this interaction, Store Framework stores use the `OrderFormProvider`, which exports the `orderForm` data to the store blocks.\n\nTwo versions of `OrderFormProvider` exist:\n\n* The legacy version was historically used by older store blocks like `minicart` and `buy-button`.\n* The new `OrderFormProvider` v2 is used by updated blocks such as `minicart.v2`, `add-to-cart-button`, and `checkout-cart`, and is now the default for any new native blocks.\n\nBy default, both the legacy and new `OrderFormProvider` are used to maintain compatibility with older blocks. However, this setup requires fetching two separate `orderForm` objects, which can slow down store performance.\n\nTo improve performance, you can disable the legacy `OrderFormProvider`, so your store only uses the newer `OrderFormProvider` v2\\. This optimization reduces unnecessary data fetching and results in smoother navigation for users.\n\n## Before you begin\n\nBefore enabling this optimization, ensure that none of your store's blocks depend on the legacy `OrderFormProvider`. If your store uses blocks like`minicart.v2` and `add-to-cart-button`, and you have no custom blocks relying on the legacy provider, it’s safe to proceed.\n\n## Instructions\n\n1. Access the VTEX Admin and go to **Store Settings > Storefront > Store**.\n2. Navigate to the **Advanced** tab and toggle the **Enable orderForm optimization** button. \n\n3. Save your changes.\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/boosting-performance/vtex-io-documentation-enabling-order-form-optimization.md)\n\n[Displaying asynchronous prices« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization//docs/guides/vtex-io-documentation-displaying-asynchronous-prices)[Getting started with Lighthouse performance auditNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization//docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\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-enabling-order-form-optimization/docs/guides/vtex-io-documentation-enabling-order-form-optimization%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-enabling-order-form-optimization%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/boosting-performance/vtex-io-documentation-enabling-order-form-optimization.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-enabling-order-form-optimization/docs/guides/vtex-io-documentation-enabling-order-form-optimization%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/docs/guides/vtex-io-documentation-enabling-order-form-optimization%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_97f081cc
|
[
{
"role": "system",
"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 orders history 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-orders-history/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-orders-history/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/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-orders-history/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/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-orders-history/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-orders-history/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/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-orders-history/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-orders-history/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-orders-history/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/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-orders-history/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/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-orders-history/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-orders-history/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/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-orders-history/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-orders-history/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-orders-history/docs/vtex-io-apps)\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-suite)\n\nB2B Orders History\n\nOfficial extension\n\nVersion: 2.0.3\n\nLatest version: 2.0.3\n\n> The **B2B Orders History** app is part of VTEX’s [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-suite) solution: a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships. We recommend that you use it alongside the other apps in this suite for all functionalities to work as expected.\n\nWhen navigating a store, B2B customers who are members of organizations often need to view past orders placed by other users in their organization or cost center.\n\nConsidering this, the **B2B Orders History** app replaces the [default Orders page](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh%23orders) in [My Account](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh) with an adapted version for the B2B scenario.\n\nIn this version of the **Orders** page, logged-in B2B customers who are members of an organization can view not only their own orders, but also orders placed by members of their organization or cost center, provided that they have the required [storefront permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions).\n\n## Before you start\n\nFirst, make sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-install) installed in your machine.\n\nTo use **B2B Orders History**, you must have the [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations) app installed in your store, which will enable you to group B2B users into organizations, with their own assigned payment methods, price tables, product collections, and cost centers.\n\nYou must also have the **Storefront Permissions** app installed – it allows you to grant specific storefront roles for B2B customers in an organization. See the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions) app documentation for information on the available roles and how to customize their permissions.\n\n## Installation\n\nYou can install the **B2B Orders History** app by running `vtex install vtex.b2b-organizations` in your terminal, using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\n## Configuration\n\nAfter installing the app, you must hide the default **Orders** page within **My Account**. To do this, follow the steps below.\n\n1. On the VTEX Admin, access **Account Settings > Apps > My apps**.\n2. In the list of apps, find **My Account** and click on its  `Settings`. \nIf you prefer, you can go directly to the URL `https://accountName.myvtex.com/admin/apps/vtex.my-account@1.x/setup/`\n3. In the **Orders** section, deselect the **Visible** checkbox, as shown in the following image.\n4. Click on `Save`.\n\n\n\n## How it works\n\nOnce the app is installed and **My Account** is configured, B2B customers who are members of an organization will be able to see all of their organization or cost center’s orders at **My Account > Orders** in the storefront, if they have the required permissions.\n\nBy default, only customers with the **Organization Admin** role can see all the organization’s orders. Users with the **Organization Approver** or **Organization Buyer** roles can only see their cost center’s orders. Note that if you have the [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions-ui) app you can customize these permissions in your VTEX Admin, on **Account Settings > Storefront Permissions**.\n\n[B2B Checkout Settings« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-checkout-settings)[B2B Quotes & CartsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-quotes)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-orders-history%23before-you-start)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-orders-history%23installation)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-orders-history%23configuration)\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history/docs/apps/vtex.b2b-orders-history%23how-it-works)\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_23e4d049
|
[
{
"role": "system",
"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 Logo 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/Logo/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/Logo/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Logo/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Logo/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Logo/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Logo/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/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/Logo/docs/vtex-io-apps)\n\nLogo\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 `logo` block displays a logo in the store header.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `logo` block into the [header](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-header/) component. For example:\n\n`1\n\n \"header.full\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"login\", \n\n4\n\n \"minicart\", \n\n5\n\n+ \"logo\", \n\n6\n\n \"search-bar\", \n\n7\n\n \"menu-link\", \n\n8\n\n \"telemarketing\", \n\n9\n\n \"category-menu\" \n\n10\n\n ] \n\n11\n\n }, \n\n`\n\n1. Then, declare the `logo` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"logo\": { \n\n2\n\n \"props\": { \n\n3\n\n \"width\": 132, \n\n4\n\n \"height\": 32, \n\n5\n\n \"mobileWidth\": 90, \n\n6\n\n \"mobileHeight\": 32 \n\n7\n\n } \n\n8\n\n } \n\n9\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n| color | String | The image fill color. | #F71963 |\n| height | Number | The logo image height. | 177 |\n| href | String | The image hyperlink. | undefined |\n| showLabel | Boolean | The label visibility. | true |\n| title | String! | The image alt description. | VTEX logo |\n| url | String | The image soure URL. | undefined |\n| width | Number | The logo image width. | 493 |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------- |\n| logoContainer |\n| logoImage |\n| logoLink |\n| sizeDesktop |\n| sizeMobile |\n\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/Logo/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/Logo/docs/apps/vtex.store-components@3.178.5/Logo%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Logo/docs/apps/vtex.store-components@3.178.5/Logo%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Logo/docs/apps/vtex.store-components@3.178.5/Logo%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_8b10fcce
|
[
{
"role": "system",
"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 breadcrumb 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.breadcrumb/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/api-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.breadcrumb/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.breadcrumb/docs/storefront-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.breadcrumb/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.breadcrumb/docs/troubleshooting)\n\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.breadcrumb/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/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.breadcrumb/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/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.breadcrumb/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.breadcrumb/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/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.breadcrumb/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.breadcrumb/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/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.breadcrumb/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/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.breadcrumb/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.breadcrumb/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/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.breadcrumb/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.breadcrumb/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.breadcrumb/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/guides/basic-components)\n\nBreadcrumb\n\nOfficial extension\n\nVersion: 1.9.5\n\nLatest version: 1.9.5\n\nThe VTEX BreadCrumb is a navigation scheme that shows a user's browsing history up to their current location in your store.\n\n\n\n## Configuration\n\n1. Import the breadcrumb's app to your theme's dependencies in the `manifest.json`, for example:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.breadcrumb\": \"1.x\" \n\n3\n\n } \n\n`\n\n1. Add the `breadcrumb` block to the Product template. 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| Prop name | Type | Description | Default value |\n| ------------- | ------- | ----------------------------------------------------------------------------------------- | ------------- |\n| showOnMobile | Boolean | It determines whether Breadcrumb should also be displayed on mobile | false |\n| homeIconSize | Number | Controls the size property of [IconHome](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons%23icons) | 26 |\n| caretIconSize | Number | Controls the size property of [IconCaret](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons%23icons) | 8 |\n\n:warning: The product's categories should appear as an array in one of this two formats:\n\n`1\n\ncategories = ['/Eletronics/', '/Eletronics/Computers'] \n\n`\n\n`1\n\ncategories = ['eletronics', 'eletronics-computers'] \n\n`\n\n1. Add the `breadcrumb.search` block to the Search template. For example:\n\n`1\n\n \"breadcrumb.search\": { \n\n2\n\n \"props\": { \n\n3\n\n \"showOnMobile\": true \n\n4\n\n } \n\n5\n\n }, \n\n`\n\n| Prop name | Type | Description | Default value |\n| ------------- | ------- | ----------------------------------------------------------------------------------------- | ------------- |\n| showOnMobile | Boolean | It determines whether Breadcrumb should also be displayed on mobile | false |\n| homeIconSize | Number | Controls the size property of [IconHome](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons%23icons) | 26 |\n| caretIconSize | Number | Controls the size property of [IconCaret](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons%23icons) | 8 |\n\n> _The `breadcrumb.search` block is specific for the Breadcrumb inside the search result page._\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ----------- |\n| container |\n| link |\n| arrow |\n| homeLink |\n| termArrow |\n\n[Banner« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.search/banner)[FooterNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.store-footer)\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.breadcrumb/docs/apps/vtex.breadcrumb%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb/docs/apps/vtex.breadcrumb%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_eddf62b9
|
[
{
"role": "system",
"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 native form for your store users in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/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-native-form-for-your-store-users/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-using-components)\n\n[Building a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n\n[Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-building-a-shelf)\n\n[Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)\n\n[Creating a native form for your store users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)\n\n[Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n\n[Overriding native app blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-overriding-native-app-blocks)\n\n[Using Sandbox blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-using-sandbox-blocks)\n\n[Using the Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-using-the-assets-builder)\n\n[Setting up Delivery Promise components (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/setting-up-delivery-promise-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/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-native-form-for-your-store-users/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/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-native-form-for-your-store-users/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-using-components)\n\n[Building a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n\n[Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-building-a-shelf)\n\n[Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)\n\n[Creating a native form for your store users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)\n\n[Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n\n[Overriding native app blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-overriding-native-app-blocks)\n\n[Using Sandbox blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-using-sandbox-blocks)\n\n[Using the Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-using-the-assets-builder)\n\n[Setting up Delivery Promise components (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/setting-up-delivery-promise-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/store-framework-using-components)\n\n[Creating a native form for your store users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)\n\nCreating a native form for your store users\n\nIn traditional brick-and-mortar stores, the sales team plays a crucial role in establishing relationships with customers, fostering trust, and providing personalized support. However, online stores lack the in-person interactions that often help reassure customers and create a direct channel for feedback and inquiries.\n\nTo bridge this gap, ecommerce stores can leverage forms as essential tools for promoting clear and direct communication with customers. Forms not only enable customers to ask questions and share suggestions but also allow businesses to gather valuable insights into customer satisfaction.\n\nWith Store Framework, your store can integrate a native form component with [Master Data v2](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw), facilitating data collection and storage.\n\n## Instructions\n\n### Step 1 - Creating the JSON Schema in Master Data v2\n\nTo begin, you must create a [JSON schema](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema) in [Master Data v2](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23v2-schemas) that defines the fields your form will include and the expected input types. This schema acts as a blueprint for your form, specifying both required data fields and storage structure.\n\nMake a request to the [Save Schema by name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-) endpoint to define your schema. Include the JSON example below as the default request body, modifying it to suit your store’s needs:\n\nSchema example\n\n`1\n\n{ \n\n2\n\n \"title\": \"Person\", \n\n3\n\n \"type\": \"object\", \n\n4\n\n \"properties\": { \n\n5\n\n \"firstName\": { \n\n6\n\n \"type\": \"string\", \n\n7\n\n \"title\": \"First Name\", \n\n8\n\n \"description\": \"The person's first name.\" \n\n9\n\n }, \n\n10\n\n \"lastName\": { \n\n11\n\n \"type\": \"string\", \n\n12\n\n \"title\": \"Last Name\", \n\n13\n\n \"description\": \"The person's last name.\" \n\n14\n\n }, \n\n15\n\n \"age\": { \n\n16\n\n \"description\": \"Age in years which must be equal to or greater than zero.\", \n\n17\n\n \"title\": \"Age\", \n\n18\n\n \"type\": \"integer\", \n\n19\n\n \"minimum\": 0, \n\n20\n\n \"maximum\": 120 \n\n21\n\n }, \n\n22\n\n \"height\": { \n\n23\n\n \"type\": \"number\", \n\n24\n\n \"minimum\": 0.3, \n\n25\n\n \"maximum\": 2.9, \n\n26\n\n \"title\": \"Your height in meters\", \n\n27\n\n \"multipleOf\": 0.01 \n\n28\n\n }, \n\n29\n\n \"emailAddress\": { \n\n30\n\n \"type\": \"string\", \n\n31\n\n \"format\": \"email\", \n\n32\n\n \"title\": \"Email address\" \n\n33\n\n }, \n\n34\n\n \"address\": { \n\n35\n\n \"title\": \"Address\", \n\n36\n\n \"type\": \"object\", \n\n37\n\n \"properties\": { \n\n38\n\n \"streetType\": { \n\n39\n\n \"type\": \"string\", \n\n40\n\n \"title\": \"Street Type\", \n\n41\n\n \"enum\": [ \n\n42\n\n \"street\", \n\n43\n\n \"road\", \n\n44\n\n \"avenue\", \n\n45\n\n \"boulevard\" \n\n46\n\n ] \n\n47\n\n }, \n\n48\n\n \"streetAddress\": { \n\n49\n\n \"type\": \"string\", \n\n50\n\n \"title\": \"Address\" \n\n51\n\n }, \n\n52\n\n \"streetNumber\": { \n\n53\n\n \"type\": \"integer\", \n\n54\n\n \"title\": \"Street Number\" \n\n55\n\n } \n\n56\n\n }, \n\n57\n\n \"required\": [ \n\n58\n\n \"streetType\", \"streetAddress\", \"streetNumber\" \n\n59\n\n ] \n\n60\n\n }, \n\n61\n\n \"agreement\": { \n\n62\n\n \"type\": \"boolean\", \n\n63\n\n \"title\": \"Do you agree with the terms?\" \n\n64\n\n } \n\n65\n\n }, \n\n66\n\n \"required\": [ \n\n67\n\n \"firstName\", \n\n68\n\n \"lastName\", \n\n69\n\n \"agreement\" \n\n70\n\n ], \n\n71\n\n \"v-security\": { \n\n72\n\n \"publicJsonSchema\": true, \n\n73\n\n \"allowGetAll\": false, \n\n74\n\n \"publicRead\": [ \"fieldExample\" ], \n\n75\n\n \"publicWrite\": [ \"fieldExample\" ], \n\n76\n\n \"publicFilter\": [ \"fieldExample\" ] \n\n77\n\n } \n\n78\n\n} \n\n`\n\n> Bear in mind that the schema's language will define the form's default language.\n\nWhen making the request to create the JSON Schema, remember to:\n\n* Replace the `dataEntityName` value with the data entity name in which you want to save the user data fetched from the form.\n* Replace the `schemaName` value with a name of your choosing. The value defined will be the form's JSON Schema name.\n\nOnce the request is executed successfully, the JSON Schema is ready and you can create the form in your store's theme.\n\n> Master Data v2 doesn't have an interface, so all actions regarding the user form must be done through the [Master Data API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23overview).\n\n### Step 2 - Configuring the Store Form app\n\nLastly, you must configure the Store Form app and the blocks it exports to make your store render the native Store Framework form component.\n\nAccess the [Store Form app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form) and follow the step-by-step instructions to complete its configuration.\n\nOnce the form is configured in your store's theme, users will be able to share their information using the component. Your store will receive this information and automatically save it in Master Data v2, so you can interact with it using the [Master Data API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23overview).\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-creating-a-native-form-for-your-store-users.md)\n\n[Configuring custom images for the SKU Selector« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users//docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)[Creating a product availability formNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users//docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\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-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users%23instructions)\n\n[Step 1 - Creating the JSON Schema in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users%23step-1-creating-the-json-schema-in-master-data-v2)[Step 2 - Configuring the Store Form app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users%23step-2-configuring-the-store-form-app)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-creating-a-native-form-for-your-store-users.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-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users%23instructions)\n\n[Step 1 - Creating the JSON Schema in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users%23step-1-creating-the-json-schema-in-master-data-v2)[Step 2 - Configuring the Store Form app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users%23step-2-configuring-the-store-form-app)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_678ecb4d
|
[
{
"role": "system",
"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 development workspace for cms legacy 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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/docs/api-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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/docs/storefront-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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/docs/troubleshooting)\n\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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/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-development-workspace-for-cms-legacy/docs/app-development)\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/docs/guides/vtex-io-documentation-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-development-workspace-for-cms-legacy/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)\n\nCreating a Development workspace for a Legacy CMS store\n\nIn this guide, you will learn how to create a Development workspace to start developing in an IO environment.\n\nWhen working in a Development workspace, the public version of your store, that is, the one that is visible to end users, will stay stable utilizing the CMS Legacy until you are ready to transition to IO.\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). Through the CLI, you can log in to your VTEX account, manage workspaces and develop new apps.\n2. Ensure that you understand the concepts of [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) and [workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace).\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), log into your VTEX account by running the following command:\n\n`1\n\nvtex login {account-name} \n\n`\n\n> Remember to replace the value between the brackets for the VTEX account name you desire. For example: `vtex login account-name`.\n\n1. Create a [new Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace).\n2. [Open a ticket to the VTEX support team](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk?%5Fga=2.222513819.1487123273.1647865109-1001456323.1619912759) requesting the installation of the `vtex.edition-store@3.x` Edition app in the new Development workspace.\n\n> The `vtex.edition-store@3.x` Edition app is responsible for enabling building elements for the frontend using the VTEX Store Framework. You can only configure and test the solution successfully after installing it.\n\nOnce the `vtex.edition-store@3.x` Edition app is installed in the Development workspace, configure the Store Framework theme you want in the Store Theme app and test it in the new Development workspace. Refer to the [Setting your store's theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme) documentation for more details.\n\n## Next steps\n\n1. Make sure to configure the Store theme for the Development workspace you have created. Refer to the [Setting your store's theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme) documentation for more details.\n2. After finishing setting your Store Theme, perform A/B testing between the Development workspace in IO and the Master workspace in the CMS legacy. Refer to the [Performing A/B testing between store versions in CMS and VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io) 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/configuring-workspaces/vtex-io-documentation-creating-development-workspace-for-cms-legacy.md)\n\n[Creating a Development workspace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy//docs/guides/vtex-io-documentation-creating-a-development-workspace)[Creating a Production workspaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy//docs/guides/vtex-io-documentation-creating-a-production-workspace)\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-creating-development-workspace-for-cms-legacy/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy%23instructions)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy%23next-steps)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-creating-development-workspace-for-cms-legacy.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-creating-development-workspace-for-cms-legacy/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy%23instructions)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy%23next-steps)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_9fab7bd7
|
[
{
"role": "system",
"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 search use pagination 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/search-use-pagination/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/api-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/search-use-pagination/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/search-use-pagination/docs/storefront-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/search-use-pagination/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/search-use-pagination/docs/troubleshooting)\n\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/search-use-pagination/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/search-use-pagination/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/search-use-pagination/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/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/search-use-pagination/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/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/search-use-pagination/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-overview)\n\n[SearchProvider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-search-provider)\n\n[usePagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-pagination)\n\n[useSearch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-search)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/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/search-use-pagination/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/search-use-pagination/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/search-use-pagination/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/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/search-use-pagination/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/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/search-use-pagination/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/search-use-pagination/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/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/search-use-pagination/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/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/search-use-pagination/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-overview)\n\n[SearchProvider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-search-provider)\n\n[usePagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-pagination)\n\n[useSearch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-search)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/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/search-use-pagination/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/search-use-pagination/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/search-use-pagination/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/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/search-use-pagination/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/sdk-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-overview)\n\nusePagination\n\nThe `usePagination` hook provides the pagination links (`next`/`prev`) for navigating through search results. These links can be used with the `<link />` tag to improve SEO and user experience by indicating the relationship between pages (example: `rel=\"next\"` and `rel=\"prev\"`).\n\n## Import\n\n`1\n\nimport { usePagination } from '@faststore/sdk' \n\n`\n\n## Usage\n\nThe following example demonstrates how to implement a paginated navigation system using `usePagination`:\n\n`1\n\nimport { usePagination } from '@faststore/sdk' \n\n2\n\n \n3\n\nfunction Component () { \n\n4\n\n const totalProducts = 100 // Total number of products returned by the search query \n\n5\n\n const { next, prev } = usePagination(totalProducts) \n\n6\n\n \n7\n\n return ( \n\n8\n\n <> \n\n9\n\n {prev && ( \n\n10\n\n <a href={prev.link} rel=\"prev\"> \n\n11\n\n Previous Page \n\n12\n\n </a> \n\n13\n\n )} \n\n14\n\n {next && ( \n\n15\n\n <a href={next.link} rel=\"next\"> \n\n16\n\n Next Page \n\n17\n\n </a> \n\n18\n\n )} \n\n19\n\n </> \n\n20\n\n ) \n\n21\n\n} \n\n`\n\n* `usePagination`: Generates pagination links (`next` and `prev`) based on the total number of products in the search results.\n* `totalProducts`: Total number of products returned by the search query. This value is used to calculate the pagination links.\n* `rel=\"prev\"` and `rel=\"next\"`: Help search engines understand the relationship between pages, improving SEO.\n\n## API reference\n\nThe `usePagination` hook returns an object containing `next` and `prev` pagination links:\n\n| Variable name | Data type | Description |\n| ------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| prev | { cursor: number; link: string} / false | Object containing the cursor position and link for the previous page of the search result. If there's no previous page, this value will be false. Example: { cursor: 10, link: '/search?page=10' }. |\n| next | { cursor: number; link: string} / false | Object containing the cursor position and link for the next page of the search result. If there's no next page, this value will be false. Example: { cursor: 20, link: '/search?page=20' }. |\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/sdk/search/use-pagination.mdx)\n\n[SearchProvider« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-search-provider)[useSearchNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-search)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-pagination%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-pagination%23usage)\n\n[API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-pagination%23api-reference)\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/search/use-pagination.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-pagination%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-pagination%23usage)\n\n[API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-use-pagination/docs/guides/faststore/search-use-pagination%23api-reference)\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_46b9109c
|
[
{
"role": "system",
"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 ProductSummaryImage 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/ProductSummaryImage/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/ProductSummaryImage/docs/api-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/ProductSummaryImage/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/ProductSummaryImage/docs/storefront-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/ProductSummaryImage/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/ProductSummaryImage/docs/troubleshooting)\n\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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/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/ProductSummaryImage/docs/vtex-io-apps)\n\nProduct Summary Image\n\n[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)\n\nVersion: 2.91.0\n\nLatest version: 2.91.0\n\n`product-summary-image` is a block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary) that renders the product image.\n\n\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme 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-image` block as a child of the `product-summary.shelf` block:\n\n`1\n\n{ \n\n2\n\n \"shelf#home\": { \n\n3\n\n \"blocks\": [\"product-summary.shelf\"] \n\n4\n\n }, \n\n5\n\n \"product-summary.shelf\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"product-summary-name\", \n\n8\n\n \"product-summary-description\", \n\n9\n\n \"product-summary-image\", \n\n10\n\n \"product-summary-price\", \n\n11\n\n \"product-summary-sku-selector\", \n\n12\n\n \"product-summary-buy-button\" \n\n13\n\n ] \n\n14\n\n }, \n\n`\n\n1. Then, declare the `product-summary-image` and configure its behavior using the props stated below.\n\n`1\n\n \"product-summary-image\": { \n\n2\n\n \"props\": { \n\n3\n\n \"showBadge\": true, \n\n4\n\n \"height\": 220 \n\n5\n\n } \n\n6\n\n } \n\n7\n\n} \n\n`\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| showBadge | boolean | Determines whether a discount badge is displayed on the product image. Setting it to true displays the badge if applicable, while false hides it. | true |\n| badgeText | string | Specify the text to be displayed on the discount badge (if the badge is configured to be shown in the product image). | undefined |\n| showCollections | boolean |  Determines whether collection badges, if available, will be displayed (true) or not (false). This prop is deprecated. Use the \\[Product Highlights\\] component instead. | false |\n| displayMode | enum | Defines the Product Summary Image display mode. Possible values are: normal and inline. | normal |\n| placeholder | string | Defines the Product Summary Image placeholder image. | undefined |\n| mainImageLabel | string | Matches the value defined in the imageLabel field from the Admin Catalog. When matched, it determines which product image will be used as the main image displayed in the Product Summary component. | undefined |\n| hoverImageLabel | string |  Text value that matches the value defined in the imageLabel field from the Admin Catalog. When matched, it determines which product image will be displayed when the user hovers over the product. If you set a label and no match is found, no image will be displayed during hover. This prop is deprecated. Use the hoverImage prop instead. | undefined |\n| hoverImage | object | Defines the criteria that should determine the hover image based on the product images in the Admin Catalog. | undefined |\n| width | object | Defines the Product Summary Image width. | undefined |\n| height | object | Defines the Product Summary Image height. | undefined |\n| aspectRatio | object | Defines the aspect ratio of the Product Summary Image, determining whether the image should be displayed in a square, portrait, landscape, or another format. The prop value should follow the [standard aspect ratio notation](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Aspect%5Fratio%5F%28image%29), which consists of two numbers separated by a colon. For example, you can use 1:1 for a square format or 3:4 for an upright portrait. This prop will not work if the width or height props are configured. | undefined |\n| maxHeight | object | Sets the maximum height for the Product Summary Image. This prop will only work if the width or height props are configured. | undefined |\n| fetchpriority | string | Sets the fetch priority hint to ('high', 'low', 'auto', or 'byPosition'). Choose 'byPosition' to adjust the image fetch priority based on its rendering position within search results or lists. This prioritization optimizes performance by ensuring images are fetched based on their relevance in the context. | 'byPosition' |\n\n* `mainImageLabel` object:\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| label | string | Matches the text value with the value defined in the imageLabel field from the Admin Catalog. When matched, it determines which product image will be displayed as the main image in the Product Summary component. If you set a label and no match is found, the main image of the product will be shown instead. | undefined |\n| labelMatchCriteria | enum | Specifies the criteria for searching the image label value. It determines whether the image label should match exactly as provided or if it just needs to contain the substring anywhere in the image label. Possible values are: exact (finds the image that matches exactly the string entered in the label field) and contains (finds the first image that includes the substring entered in the label field). | exact |\n\n* `hoverImage` object:\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| criteria | enum | Defines the criteria that should determine the hover image based on the product images from the Admin Catalog. Possible values are: label (the hover image will be the one that matches the label value) and index (the hover image will be the one with the same index value). | label |\n| label | string | Determines the text string to match the desired image's label value. No image will be displayed during the hover if no match is found. _Caution_: This prop should only be used when the criteria prop is set to label. | undefined |\n| labelMatchCriteria | enum | Defines the criteria for searching the image label value, determining whether the image label should match exactly as provided or just need to contain the substring anywhere in the image label. Possible values are: exact (finds the image that matches exactly the string entered the label field) and contains (finds the first image that includes the substring entered the label field). _This prop should only be used when the criteria prop is set to label_. | exact |\n| index | number | Index number to match with the desired images. No image will be displayed during hover if no match is found. _This prop should only be used when the criteria prop is set to index_. | undefined |\n\n* `width` object:\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------ | ------------- |\n| desktop | number | Image width for desktop users. | undefined |\n| mobile | number | Image width for mobile users. | undefined |\n\n* `height` object:\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------- | ------------- |\n| desktop | number | Image height for desktop users. | undefined |\n| mobile | number | Image height for mobile users. | undefined |\n\n* `aspectRatio` object:\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------------- | ------------- |\n| desktop | string | Image aspect ratio for desktop users. | undefined |\n| mobile | string | Image aspect ratio for mobile users. | undefined |\n\n* `maxHeight` object:\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------- | ------------- |\n| desktop | string | Image maximum height for desktop users. | undefined |\n| mobile | string | Image maximum height for mobile users. | undefined |\n\nThe `width`, `height`, `aspectRatio`, and `maxHeight` props use the [responsive values logic](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/responsive-values%23vtexresponsive-values).\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| hoverImage |\n| hoverEffect |\n| imageContainer |\n| imageInline |\n| imageNormal |\n| imageStackContainer |\n| mainImageHovered |\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/ProductSummaryImage/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/ProductSummaryImage/docs/apps/vtex.product-summary@2.91.0/ProductSummaryImage%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryImage/docs/apps/vtex.product-summary@2.91.0/ProductSummaryImage%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_e92b03ec
|
[
{
"role": "system",
"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 wordpress integration 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.wordpress-integration/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/api-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.wordpress-integration/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.wordpress-integration/docs/storefront-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.wordpress-integration/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.wordpress-integration/docs/troubleshooting)\n\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.wordpress-integration/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/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.wordpress-integration/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.wordpress-integration/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/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.wordpress-integration/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.wordpress-integration/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.wordpress-integration/docs/vtex-io-apps)\n\nWordpress Integration\n\nOfficial extension\n\nVersion: 2.25.2\n\nLatest version: 2.25.2\n\n## ⚠️ Maintenance ⚠️\n\n_Starting June 1st 2023, this application will no longer be maintained by VTEX._\n\n---\n\n[](#contributors-)\n\nThe Wordpress Integration app provides a way to bring in blog data from the Wordpress API and create a blog homepage, category pages, and blog post pages on your store, using your existing store header, footer, and styling.\n\n## Configuration\n\n### Step 1 - Installing the Wordpress Integration app\n\nUsing your terminal and [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install), log in to the VTEX account you are working on and [install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store/installing-an-app) the `vtex.wordpress-integration@2.x` app.\n\n### Step 2 - Defining the app settings\n\nIn your VTEX account's admin, perform the following actions:\n\n1. Access the **Apps** section and then **My Apps**.\n2. Select the **Wordpress Integration** app box and open the Settings section.\n3. If your VTEX store uses multiple bindings, enable the **configuration by binding** option to configure the app settings specific to each binding.\n4. Enter your **Wordpress URL**. This should be the domain where the Wordpress API endpoint is hosted and Wordpress is administered.\n5. If your Wordpress installation's API is hosted under a path other than `wp-json/wp/v2/`, enter the path in the **Wordpress API path** field. For example, if the `posts` endpoint looks like `https://example.wordpress.com/index.php?rest_route=/wp/v2/posts`, enter `index.php?rest_route=/wp/v2/` here. If unsure, leave the field blank.\n6. Enter the **Title tag for block homepage** which will determine the title tag for the Wordpress portions of your store.\n7. Enter the **Store blog home path** which is used to include Wordpress posts in the sitemap and be indexed by search engines. For example, the path to your store's blog is [www.my-store.com/blog](https://read.calvincode.net/reader?url=http://www.my-store.com/blog), you would enter 'blog'.\n8. Select the filters that you want to show, this filters will appear as part of the pagination in both search posts and all posts views, you can filter by category, tag, and/or date.\n9. Save your changes.\n\n⚠️ If you have a security plugin installed on your WordPress installation (such as WordFence), ensure it is not blocking requests to `/users` or `/?author=N` queries.\n\nℹ️ _The settings option `Create Sitemap Entries` will likely not need to be modified. This setting tells the app to create the initial sitemap entries. Once this is done, the app programmatically updates this setting to prevent duplicate sitemap entires._\n\n### Step 3 - Creating the blog pages\n\nIt is time to create the store pages that will host the blog content. Before performing the following actions, make sure you already are logged into the desired VTEX account and working on a [Developer workspace](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/creating-a-development-workspace/).\n\n1. Open your Store Theme app in your code editor.\n2. Add the `wordpress-integration` app as a `peerDependency` in your theme's `manifest.json` file:\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n+ \"vtex.wordpress-integration\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. In the `store/routes.json` file, create paths for the blog's new pages as shown below:\n\n`1\n\n\"store.blog-home\": { \n\n2\n\n \"path\": \"/blog\" \n\n3\n\n}, \n\n4\n\n\"store.blog-category\": { \n\n5\n\n \"path\": \"/blog/category/:categoryslug_id\" \n\n6\n\n}, \n\n7\n\n\"store.blog-post\": { \n\n8\n\n \"path\": \"/blog/post/:slug_id\" \n\n9\n\n}, \n\n10\n\n\"store.blog-search-result\": { \n\n11\n\n \"path\": \"/blog/search/:term_id\" \n\n12\n\n} \n\n`\n\nℹ️ _You may change `blog` in each route to another string of your choosing._\n\n| Blog page | Description |\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |\n| store.blog-home | The homepage of your blog. This can also be extended (i.e. store.blog-home#custom) to create additional custom blog pages, if needed. |\n| store.blog-category | A listing of blog posts belonging to a particular category, derived from a category slug in the page route. |\n| store.blog-post | A detail view of a single blog post, derived from a post slug in the page route. |\n| store.blog-search-result | A listing of blog posts matching a search query, derived from a search term in the page route. |\n\nIf you wish to display WordPress **pages** on your store site in addition to **posts**, you can add a route like the one shown below:\n\n`1\n\n\"store.custom#blog-page\": { \n\n2\n\n \"path\": \"/blog/page/:slug\" \n\n3\n\n} \n\n`\n\nIn addition to that, you can optionally add `:page` parameters for URL-controlled pagination. For example:\n\n`1\n\n\"store.blog-home\": { \n\n2\n\n \"path\": \"/blog(/page/:page)\" \n\n3\n\n}, \n\n4\n\n\"store.blog-category\": { \n\n5\n\n \"path\": \"/blog/category/:categoryslug_id(/page/:page)\" \n\n6\n\n}, \n\n7\n\n\"store.blog-search-result\": { \n\n8\n\n \"path\": \"/blog/search/:term_id(/page/:page)\" \n\n9\n\n}, \n\n`\n\nIf the `:page` parameter is not provided, pagination can alternatively be controlled by query string, such as `/blog/category/example-category?page=2` .\n\n### Step 4 - Declaring the pages' blocks\n\nOnce the routes are set up, you may populate each blog page with blocks.\n\nThe Wordpress Integration app provides the following blocks for your use:\n\n| Block name | Description |\n| -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| blog-all-posts.wordpress-all-posts | Paginated list of all blog posts, starting with the most recent. Recommended to be placed on store.blog-home page. |\n| blog-category-list.wordpress-category-list | Paginated list of blog posts from a specific category. This must be placed on the store.blog-category page, as the category slug is provided by the parameter in the page route. |\n| blog-post-details.wordpress-post-details | Shows the details for a single blog post. This must be placed on the store.blog-post page, as the post slug is provided by the parameter in the page route. |\n| blog-page-details.wordpress-page-details | Shows the details for a single blog page. This must be placed on a customized store.blog-home#page page to render the contents via the slug passed through the route parameter. |\n| blog-latest-posts-preview.wordpress-latest-posts-preview | Shows teasers for the most recent 3-5 posts (default is 3). |\n| blog-category-preview.wordpress-category-preview | Shows teasers for the most recent 3-5 posts from a specific category (default is 3). The category ID must be provided as a prop. |\n| blog-search.wordpress-search | Search box that shoppers can use to search blog articles. When submitted, the shopper is redirected to the store.blog-search-list page. |\n| blog-search-list.wordpress-search-list | Paginated list of blog post search results. This must be placed on the store.blog-search page, as the search terms are provided by the parameter in the page route. |\n| search-blog-articles-preview.wordpress | Shows teasers for the most recent 3-5 posts in the store search results page with a link to the store.blog-search-list page. This can only be placed on the main store.search-result template and uses the same search query as the product search component on that page. |\n| search-blog-articles-list.wordpress | An alternative to the search-blog-articles-preview.wordpress block, but instead this block shows a _complete_ paginated list of posts in the search results page. It automatically uses the same search query as the product search component on that page. |\n| blog-related-products.wordpress-related-products | A specialized wrapper for a product shelf that can be placed on the store.blog-post page. It must be a child of the blog-post-details.wordpress-post-details block. This allows you to tag Wordpress posts with product reference codes, and the products in question will then be displayed in the shelf. The tags must be in the format prod-\\[reference code\\]. For example, if your product had a reference code of VTEX01, the tag should be prod-VTEX01. This block must have product-summary.shelf as a child. |\n| blog-post-container.wordpress | A context component that provides data for an individual blog post to its child blocks. This must be placed on the store.blog-post page. |\n| blog-post-navigation.wordpress | A component that renders \"Previous Article\" and \"Next Article\" buttons. Must be placed as a child of a blog-post-container.wordpress block. |\n| blog-related-posts.wordpress-related-posts | Similar to the above, but the reverse: this is a block intended to be placed in the theme's store.product page template which will show teasers for 3-5 blog posts (3 by default) that are tagged with the reference code of the product being viewed. |\n| blog-breadcrumb.wordpress-breadcrumb | A breadcrumb component intended to be placed at the top of each blog page. |\n| blog-search-list.wordpress-category-related-posts | A block that can be used to display the title and body of one or more posts on a store category or department page. Use case: SEO text for your store's departments. By default, when placed on a store category or department page, the block will attempt to display a WordPress post tagged category-{id}, where {id} is the numeric ID of your VTEX store department. |\n\n#### `blog-all-posts.wordpress-all-posts` props\n\n| Prop Name | Type | Description | Default value |\n| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| mediaSize | MediaSizeEnum | WordPress media image size that should be used in the blog's preview blocks. | full |\n| ampLinks | boolean | Whether the links from each blog post should point to the external blog AMP (Accelrated Mobile Page) in a new tab (true) or not (false). Only valid for AMPs generated using the [WordPress AMP plugin](https://read.calvincode.net/reader?url=https://wordpress.org/plugins/amp/). | false |\n| ampUrlFormat | string | URL structure for AMP links. ampPathSuffix appends /amp to the end of the external blog post URL. ampQuery appends ?amp and ampQueryValue appends ?amp=1. For example, possible URLs are <https://www.wordpressblog.com/blog-post/amp>, <https://www.wordpressblog.com/blog-post?amp>, or <https://www.wordpressblog.com/blog-post?amp=1>. | ampPathSuffix |\n| excerptLink | boolean | Whether the post excerpts should be clickable links (true) or not (false). | false |\n\n#### `blog-category-list.wordpress-category-list` props\n\n| Prop Name | Type | Description | Default value |\n| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| mediaSize | MediaSizeEnum | WordPress media image size that should be used in the blog's preview blocks. | full |\n| ampLinks | boolean | Whether the links from each blog post should point to the external blog AMP (Accelrated Mobile Page) in a new tab (true) or not (false). Only valid for AMPs generated using the [WordPress AMP plugin](https://read.calvincode.net/reader?url=https://wordpress.org/plugins/amp/). | false |\n| ampUrlFormat | string | URL structure for AMP links. ampPathSuffix appends /amp to the end of the external blog post URL. ampQuery appends ?amp and ampQueryValue appends ?amp=1. For example, possible URLs are <https://www.wordpressblog.com/blog-post/amp>, <https://www.wordpressblog.com/blog-post?amp>, or <https://www.wordpressblog.com/blog-post?amp=1>. | ampPathSuffix |\n| excerptLink | boolean | Whether the post excerpts should be clickable links (true) or not (false). | false |\n\n#### `blog-latest-posts-preview.wordpress-latest-posts-preview` props\n\n| Prop Name | Type | Description | Default value |\n| ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| title | string | Title to be displayed above the block. | null |\n| numberOfPosts | number | The number of posts to be displayed. | 3 |\n| tags | array | Array of tag IDs allowed. When this property is included, only posts that contain all the listed tags will be displayed. | undefined |\n| excludeTags | array | Array of tag IDs to be excluded. Posts containing any of the excluded tags will not be displayed. | undefined |\n| excludeCategories | array | Array of category IDs to be excluded. Posts containing any of the excluded categories will not be displayed. | undefined |\n| useTextOverlays | boolean | Whether each blog post data (title, category, etc) should be overlaid on the post's featured image (true) or not (false). If false, date of publication and category are shown above the image, title and excerpts are shown below it. | false |\n| showCategories | boolean | Whether the post category should be shown (true) or not (false). | true |\n| showDates | boolean | Whether the date of publication should be shown (true) or not (false). | true |\n| showAuthors | boolean | Whether the post author should be shown (true) or not (false). | false |\n| showExcerpts | boolean | Whether the post excerpts should be shown (true) or not (false). | false |\n| excerptLink | boolean | Whether the post excerpts should be clickable links (true) or not (false). | false |\n| mediaSize | MediaSizeEnum | WordPress media image size that should be used in the blog's preview blocks. | full |\n| absoluteLinks | boolean | Whether the links from each blog post should point to the external blog in a new tab (true) or not (false). | false |\n| ampLinks | boolean | Whether the links from each blog post should point to the external blog AMP (Accelrated Mobile Page) in a new tab (true) or not (false). Only valid for AMPs generated using the [WordPress AMP plugin](https://read.calvincode.net/reader?url=https://wordpress.org/plugins/amp/). If true but AMP is not enabled for a particular post and absoluteLinks is enabled, then the the external blog post link will be used instead. | false |\n| ampUrlFormat | string | URL structure for AMP links. ampPathSuffix appends /amp to the end of the external blog post URL. ampQuery appends ?amp and ampQueryValue appends ?amp=1. For example, possible URLs are <https://www.wordpressblog.com/blog-post/amp>, <https://www.wordpressblog.com/blog-post?amp>, or <https://www.wordpressblog.com/blog-post?amp=1>. | ampPathSuffix |\n\n#### `blog-category-preview.wordpress-category-preview` props\n\n| Prop Name | Type | Description | Default value |\n| ---------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |\n| category | number | The numeric ID of the category in the WordPress system. | 0 |\n| title | string | Title to be displayed above the component. | null |\n| description | string | Subheader to be displayed below the component's title. | null |\n| customLinkText | string | Text to be displayed as a link to the store.blog-category page (according to the given category). | All \\[category\\] Posts > |\n| customLinkTarget | string | If you would like the aforementioned link to direct the user somewhere other than the store.blog-category page, you may enter a different target using this prop. | undefined |\n| numberOfPosts | number | Number of posts to be displayed. | 3 |\n| useTextOverlays | boolean | Whether each blog post data (title, category, etc) should be overlaid on the post's featured image (true) or not (false). If false, date of publication and category are shown above the image, title and summary are shown below it. | false |\n| showDates | boolean | Whether the date of publication should be shown (true) or not (false). | true |\n| showAuthors | boolean | Whether the post author should be shown (true) or not (false). | false |\n| showExcerpts | boolean | Whether the post excerpts should be shown (true) or not (false). | false |\n| excerptLink | boolean | Whether the post excerpts should be clickable links (true) or not (false). | false |\n| mediaSize | MediaSizeEnum | WordPress media image size that should be used in the blog's preview blocks. | full |\n| absoluteLinks | boolean | Whether the links from each blog post should point to the external blog in a new tab (true) or not (false). | false |\n| showPostButton | boolean | Displays a button that allows the user to link directly to WP post (true) or not (false). | false |\n| ampLinks | boolean | Whether the links from each blog post should point to the external blog AMP (Accelrated Mobile Page) in a new tab (true) or not (false). Only valid for AMPs generated using the [WordPress AMP plugin](https://read.calvincode.net/reader?url=https://wordpress.org/plugins/amp/). If true but AMP is not enabled for a particular post and absoluteLinks is enabled, then the the external blog post link will be used instead. | false |\n| ampUrlFormat | string | URL structure for AMP links. ampPathSuffix appends /amp to the end of the external blog post URL. ampQuery appends ?amp and ampQueryValue appends ?amp=1. For example, possible URLs are <https://www.wordpressblog.com/blog-post/amp>, <https://www.wordpressblog.com/blog-post?amp>, or <https://www.wordpressblog.com/blog-post?amp=1>. | ampPathSuffix |\n\n#### `blog-search.wordpress-search` props\n\n| Prop Name | Type | Description | Default value |\n| ----------- | ------ | ------------------------------ | ------------------ |\n| placeholder | string | Component's input placeholder. | Search articles... |\n\n#### `blog-search-list.wordpress-search-list` props\n\n| Prop Name | Type | Description | Default value |\n| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| mediaSize | MediaSizeEnum | WordPress media image size that should be used in the blog's preview blocks. | full |\n| ampLinks | boolean | Whether the links from each blog post should point to the external blog AMP (Accelrated Mobile Page) in a new tab (true) or not (false). Only valid for AMPs generated using the [WordPress AMP plugin](https://read.calvincode.net/reader?url=https://wordpress.org/plugins/amp/). | false |\n| ampUrlFormat | string | URL structure for AMP links. ampPathSuffix appends /amp to the end of the external blog post URL. ampQuery appends ?amp and ampQueryValue appends ?amp=1. For example, possible URLs are <https://www.wordpressblog.com/blog-post/amp>, <https://www.wordpressblog.com/blog-post?amp>, or <https://www.wordpressblog.com/blog-post?amp=1>. | ampPathSuffix |\n| excerptLink | boolean | Whether the post excerpts should be clickable links (true) or not (false). | false |\n\n#### `search-blog-articles-preview.wordpress` props\n\n| Prop Name | Type | Description | Default value |\n| --------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| numberOfPosts | number | The number of posts to be displayed. | 3 |\n| useTextOverlays | boolean | Whether each blog post data (title, category, etc) should be overlaid on the post's featured image (true) or not (false). If false, date of publication and category are shown above the image, title and excerpts are shown below it. | false |\n| showCategories | boolean | Whether the post category should be shown (true) or not (false). | true |\n| showDates | boolean | Whether the date of publication should be shown (true) or not (false). | true |\n| showAuthors | boolean | Whether the post author should be shown (true) or not (false). | false |\n| showExcerpts | boolean | Whether the post excerpts should be shown (true) or not (false). | false |\n| excerptLink | boolean | Whether the post excerpts should be clickable links (true) or not (false). | false |\n| mediaSize | MediaSizeEnum | WordPress media image size that should be used in the blog's preview blocks. | full |\n| absoluteLinks | boolean | Whether the links from each blog post should point to the external blog in a new tab (true) or not (false). | false |\n| ampLinks | boolean | Whether the links from each blog post should point to the external blog AMP (Accelrated Mobile Page) in a new tab (true) or not (false). Only valid for AMPs generated using the [WordPress AMP plugin](https://read.calvincode.net/reader?url=https://wordpress.org/plugins/amp/). If true but AMP is not enabled for a particular post and absoluteLinks is enabled, then the the external blog post link will be used instead. | false |\n| ampUrlFormat | string | URL structure for AMP links. ampPathSuffix appends /amp to the end of the external blog post URL. ampQuery appends ?amp and ampQueryValue appends ?amp=1. For example, possible URLs are <https://www.wordpressblog.com/blog-post/amp>, <https://www.wordpressblog.com/blog-post?amp>, or <https://www.wordpressblog.com/blog-post?amp=1>. | ampPathSuffix |\n\n#### `blog-related-posts.wordpress-related-posts` props\n\n| Prop Name | Type | Description | Default value |\n| --------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| title | string | Title to be displayed above the component. | null |\n| numberOfPosts | number | The number of posts to be displayed. | 3 |\n| useTextOverlays | boolean | Whether each blog post data (title, category, etc) should be overlaid on the post's featured image (true) or not (false). If false, date of publication and category are shown above the image, title and excerpts are shown below it. | false |\n| showCategories | boolean | Whether the post category should be shown (true) or not (false). | true |\n| showDates | boolean | Whether the date of publication should be shown (true) or not (false). | true |\n| showAuthors | boolean | Whether the post author should be shown (true) or not (false). | false |\n| showExcerpts | boolean | Whether the post excerpts should be shown (true) or not (false). | false |\n| showExcerpts | boolean | Whether the post excerpts should be shown (true) or not (false). | false |\n| excerptLink | boolean | Whether the post excerpts should be clickable links (true) or not (false). | false |\n| mediaSize | MediaSizeEnum | WordPress media image size that should be used in the blog's preview blocks. | full |\n| absoluteLinks | boolean | Whether the links from each blog post should point to the external blog in a new tab (true) or not (false). | false |\n| ampLinks | boolean | Whether the links from each blog post should point to the external blog AMP (Accelrated Mobile Page) in a new tab (true) or not (false). Only valid for AMPs generated using the [WordPress AMP plugin](https://read.calvincode.net/reader?url=https://wordpress.org/plugins/amp/). If true but AMP is not enabled for a particular post and absoluteLinks is enabled, then the the external blog post link will be used instead. | false |\n| ampUrlFormat | string | URL structure for AMP links. ampPathSuffix appends /amp to the end of the external blog post URL. ampQuery appends ?amp and ampQueryValue appends ?amp=1. For example, possible URLs are <https://www.wordpressblog.com/blog-post/amp>, <https://www.wordpressblog.com/blog-post?amp>, or <https://www.wordpressblog.com/blog-post?amp=1>. | ampPathSuffix |\n\n#### `blog-search-list.wordpress-category-related-posts` props\n\n| Prop Name | Description | Type | Default value |\n| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | -------------- |\n| categoryIdentifier | You may manually specify the ID to be used in the WordPress tag. For example, if you set this prop to \"test\", the block will look for a WordPress post tagged \"category-test\". | String | (empty string) |\n| numberOfPosts | number | The number of posts to be displayed. | 3 |\n\n#### `MediaSizeEnum` Possible Values\n\n| Enum Name | Enum Value | Description |\n| ------------ | ------------- | ----------------------------------------------------------- |\n| Thumbnail | thumbnail | Uses the WordPress Media Settings Thumbnail size values. |\n| Medium | medium | Uses the WordPress Media Settings Medium size values. |\n| Medium Large | medium\\_large | Uses the WordPress Media Settings Medium Large size values. |\n| Large | large | Uses the WordPress Media Settings Large size values. |\n| Full | full | Uses the original image size values. |\n\n### Paginated List Customization\n\nBlocks that use a paginated list accept some common props that allow customization of the paginated list behavior.\n\nThese blocks include:\n\n* `blog-all-posts.wordpress-all-posts`\n* `blog-category-list.wordpress-category-list`\n* `blog-search-list.wordpress-search-list`\n* `search-blog-articles-list.wordpress`\n\n| Prop Name | Description | Type | Default value |\n| ------------ | ------------------------------------------------------ | ------ | ------------- |\n| postsPerPage | Number of posts to be displayed in the paginated list. | Number | 10 |\n\n## Advanced configuration\n\n### Multiple WordPress installations\n\nStarting with version 1.6.0 of this app, blog content from **multiple WordPress installations** is supported.\n\nTo accomplish this, a `customdomainslug` parameter must be added to your blog routes, and your WordPress blocks must be updated with various props.\n\nℹ️ _This configuration is not required if you only wish to display blog content from a single WordPress domain._\n\n#### Step 1 - Adding the `customdomainslug` parameter\n\nIt is time to create the store pages that will host the blog content. Before performing the following actions, make sure you already are logged into the desired VTEX account and working on a [Developer workspace](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/creating-a-development-workspace/).\n\n1. In the `store/routes.json` file, add the `customdomainslug` parameter to the paths for the blog's new pages. For example:\n\n`1\n\n\"store.blog-home\": { \n\n2\n\n \"path\": \"/blog\" \n\n3\n\n}, \n\n4\n\n\"store.blog-category\": { \n\n5\n\n \"path\": \"/:customdomainslug/category/:categoryslug_id\" \n\n6\n\n}, \n\n7\n\n\"store.blog-post\": { \n\n8\n\n \"path\": \"/:customdomainslug/post/:slug_id\" \n\n9\n\n}, \n\n10\n\n\"store.blog-search-result\": { \n\n11\n\n \"path\": \"/:customdomainslug/search/:term_id\" \n\n12\n\n}, \n\n13\n\n\"store.custom#blog-page\": { \n\n14\n\n \"path\": \"/:customdomainslug/page/:slug_id\" \n\n15\n\n} \n\n`\n\n⚠️ **\\*Note that the blog homepage should continue to use a specific path**. It can be `blog` as in the example, or a different string of your choice. All other routes should use the `:customdomainslug` dynamic parameter.\\*\n\n#### Step 2 - Updating the blocks' props\n\nIn order to support multiple WordPress installations, you will need to update the theme block's list of props.\n\nFirst, add the `customDomains` prop to blocks that use the URL params to load blog data. Namely, they are:\n\n* `blog-category-list.wordpress-category-list`\n* `blog-post-details.wordpress-post-details`\n* `blog-post-details.wordpress-page-details`\n* `blog-search-list.wordpress-search-list`\n* `blog-breadcrumb.wordpress-breadcrumb`\n\nThe value of the `customDomains` prop should be a JSON list of domain \"slugs\" and the domain that each slug represents. The first entry should be your \"default\" slug and domain.\n\nFor example, if you wanted URLs with the slug `blog` to load content from `http://www.blog.com/` and URLs with the slug `other-blog` to load content from `http://www.otherblog.com/`, you would give each block a prop like this:\n\n`1\n\n{ \n\n2\n\n \"props\": { \n\n3\n\n \"customDomains\": \"{ \\\"blog\\\":\\\"http://www.blog.com/\\\",\\\"other-blog\\\":\\\"http://www.otherblog.com/\\\" }\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\nℹ️ _Make sure to follow the format of the example value, including the brackets and escaped double quotes._\n\nBlocks that do not use URL params should be given a different set of props, namely `customDomainSlug` and `customDomain`. These blocks are:\n\n* `blog-all-posts.wordpress-all-posts`\n* `blog-latest-posts-preview.wordpress-latest-posts-preview`\n* `blog-category-preview.wordpress-category-preview`\n* `blog-search.wordpress-search`\n* `search-blog-articles-preview.wordpress`\n* `search-blog-articles-list.wordpress`\n* `blog-related-posts.wordpress-related-posts`\n* `blog-search-list.wordpress-category-related-posts`\n\n`customDomainSlug` must be provided for _all_ blocks when using multiple WordPress installations. `customDomain`, in turn, only needs to be provided for blocks that are _not_ using the default WordPress domain from the app settings.\n\nContinuing the example from above, any block that shows content from the \"default\" WordPress domain should receive the `customDomainSlug` prop with a value of `blog`. Blocks that show content from the secondary WordPress domain should receive a `customDomainSlug` prop with a value of `other-blog` and a `customDomain` prop with a value of `http://www.other-blog.com/` also. For example:\n\n`1\n\n\"store.blog-home\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"blog-search.wordpress-search\", \n\n4\n\n \"blog-latest-posts-preview.wordpress-latest-posts-preview\", \n\n5\n\n \"blog-category-preview.wordpress-category-preview#test\", \n\n6\n\n \"blog-all-posts.wordpress-all-posts\" \n\n7\n\n ] \n\n8\n\n }, \n\n9\n\n \"blog-search.wordpress-search\": { \n\n10\n\n \"props\": { \n\n11\n\n \"customDomainSlug\": \"blog\" \n\n12\n\n } \n\n13\n\n }, \n\n14\n\n \"blog-latest-posts-preview.wordpress-latest-posts-preview\": { \n\n15\n\n \"props\": { \n\n16\n\n \"title\": \"Latest Posts\", \n\n17\n\n \"useTextOverlays\": true, \n\n18\n\n \"customDomainSlug\": \"blog\" \n\n19\n\n } \n\n20\n\n }, \n\n21\n\n \"blog-category-preview.wordpress-category-preview#test\": { \n\n22\n\n \"props\": { \n\n23\n\n \"category\": 5, \n\n24\n\n \"description\": \"Description of category\", \n\n25\n\n \"useTextOverlays\": false, \n\n26\n\n \"customDomain\": \"http://www.otherblog.com/\", \n\n27\n\n \"customDomainSlug\": \"other-blog\" \n\n28\n\n } \n\n29\n\n }, \n\n30\n\n \"blog-all-posts.wordpress-all-posts\": { \n\n31\n\n \"props\": { \n\n32\n\n \"customDomainSlug\": \"blog\" \n\n33\n\n } \n\n34\n\n }, \n\n`\n\nℹ️ _Make sure to follow the format of the example value, including the brackets and escaped double quotes._\n\n### Adding Subcategories to blog URLs\n\nTo have subcategories included in your blog URLs (`/blog/category/subcategory`), you will need to update your store's `routes.json`, as well as the theme's blocks that display category-related URLs.\n\nAdd an additional category route including the `:categoryslug` and `:subcategoryslug_id` parameter:\n\n`1\n\n\"store.blog-category\": { \n\n2\n\n \"path\": \"/blog/category/:categoryslug_id\" \n\n3\n\n}, \n\n4\n\n\"store.blog-category#subcategory\": { \n\n5\n\n \"path\": \"/blog/category/:categoryslug/:subcategoryslug_id\" \n\n6\n\n}, \n\n`\n\nDeclare the subcategory block:\n\n`1\n\n\"store.blog-category#subcategory\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"blog-category-list.wordpress-category-list\" \n\n4\n\n ] \n\n5\n\n}, \n\n`\n\nAdd the prop `subcategoryUrls` with a value of `true` to the blocks below:\n\n* 'blog-all-posts.wordpress-all-posts'\n* `blog-breadcrumb.wordpress-breadcrumb`\n* 'blog-category-list.wordpress-category-list'\n* 'blog-category-preview.wordpress-category-preview'\n* 'blog-latest-posts-preview.wordpress-latest-posts-preview'\n* `blog-post-details.wordpress-post-details`\n* 'blog-related-products.wordpress-related-products'\n* 'search-blog-articles-list.wordpress'\n* 'search-blog-articles-preview.wordpress'\n\nFor example:\n\n`1\n\n\"blog-all-posts.wordpress-all-posts\": { \n\n2\n\n \"props\": { \n\n3\n\n \"subcategoryUrls\": true \n\n4\n\n } \n\n5\n\n}, \n\n`\n\n## WordPress Plugins Support\n\n### Yoast SEO\n\nThe [Yoast SEO plugin](https://read.calvincode.net/reader?url=https://yoast.com/wordpress/plugins/seo/) provides meta tags and structured data for your WordPress content. If your WordPress installation has this plugin, the app will include this data on your posts or pages.\n\n### AMP (Accelerated Mobile Pages)\n\nThe [AMP plugin](https://read.calvincode.net/reader?url=https://wordpress.org/plugins/amp/) lets you build AMP pages in your WordPress site. If your WordPress installation has this plugin, and your blog posts are AMP enabled, then the app will allow you to redirect visitors to the AMP version of your blog posts.\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| breadcrumbContainer |\n| breadcrumbHomeLink |\n| breadcrumbLink |\n| breadcrumbSeparator |\n| breadcrumbCurrentPage |\n| categoryBlockContainer |\n| categoryBlockTitle |\n| categoryBlockDescription |\n| categoryBlockFlex |\n| categoryBlockFlexItem |\n| categoryBlockLink |\n| categorySelectContainer |\n| dateSelectContainer |\n| dateSelectInnerContainer |\n| dateRangeInputsContainer |\n| dateInputContainer |\n| dateFilterButtonsContainer |\n| filtersContainer |\n| latestPostsBlockContainer |\n| latestPostsBlockTitle |\n| latestPostsBlockFlex |\n| latestPostsBlockFlexFirstColumnItem |\n| latestPostsBlockFlexSecondColumn |\n| latestPostsBlockFlexSecondColumnItem |\n| latestPostsBlockFlexItem |\n| listTitle |\n| listContainer |\n| listFlex |\n| listFlexItem |\n| paginationComponent |\n| postFlex |\n| postContainer |\n| postTitle |\n| postMeta |\n| postMetaDate |\n| postMetaAuthor |\n| postMetaCategory |\n| postFeaturedImage |\n| postFeaturedImageContainer |\n| postBody |\n| postCategoryLink |\n| postChildrenContainer |\n| postNavigationContainer |\n| postNavigationFlex |\n| postNavigationFlexItem |\n| postNavigationLink |\n| relatedPostsBlockContainer |\n| relatedPostsBlockTitle |\n| relatedPostsBlockFlex |\n| relatedPostsBlockFlexItem |\n| searchBlockContainer |\n| searchListTitle |\n| searchListContainer |\n| searchListFlex |\n| searchListFlexItem |\n| searchResultBlockContainer |\n| searchResultBlockTitle |\n| searchResultBlockFlex |\n| searchResultBlockFlexItem |\n| searchResultBlockLink |\n| tagSelectContainer |\n| teaserAuthor |\n| teaserCategoryLink |\n| teaserContainer |\n| teaserDate |\n| teaserGradientOverlay |\n| teaserHeader |\n| teaserImageContainer |\n| teaserImage |\n| teaserBody |\n| teaserSeparator |\n| teaserTextOverlay |\n| teaserTextOverlayTitle |\n| teaserTextOverlayMeta |\n| teaserTitle |\n| teaserTitleLink |\n| wordpressContentLink |\n| wordpressRelatedProducts |\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[⚠️ Maintenance ⚠️](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23-maintenance-)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23configuration)\n\n[Step 1 - Installing the Wordpress Integration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23step-1-installing-the-wordpress-integration-app)[Step 2 - Defining the app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23step-2-defining-the-app-settings)[Step 3 - Creating the blog pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23step-3-creating-the-blog-pages)[Step 4 - Declaring the pages' blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23step-4-declaring-the-pages-blocks)[Paginated List Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23paginated-list-customization)\n\n[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23advanced-configuration)\n\n[Multiple WordPress installations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23multiple-wordpress-installations)[Adding Subcategories to blog URLs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23adding-subcategories-to-blog-urls)\n\n[WordPress Plugins Support](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23wordpress-plugins-support)\n\n[Yoast SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23yoast-seo)[AMP (Accelerated Mobile Pages)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%23amp-accelerated-mobile-pages)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.wordpress-integration/docs/apps/vtex.wordpress-integration%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_30c0d2c1
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides change orders multilevel omnichannel inventory external marketplaces in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/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/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/multilevel-omnichannel-inventory)\n\n[Multilevel omnichannel inventory API integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/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/change-orders-multilevel-omnichannel-inventory-external-marketplaces/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/change-orders-multilevel-omnichannel-inventory-external-marketplaces/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/change-orders-multilevel-omnichannel-inventory-external-marketplaces/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/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/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/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/multilevel-omnichannel-inventory)\n\n[Multilevel omnichannel inventory API integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/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/change-orders-multilevel-omnichannel-inventory-external-marketplaces/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/change-orders-multilevel-omnichannel-inventory-external-marketplaces/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/change-orders-multilevel-omnichannel-inventory-external-marketplaces/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/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides)\n\nLogistics\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/multilevel-omnichannel-inventory)\n\n[Change chain orders in external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)\n\nChange chain orders in external marketplaces\n\n> The [Multilevel Omnichannel Inventory (MOI)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) feature has been discontinued for integrations with external marketplaces. Now, MOI is available only for integrations between VTEX marketplaces and sellers. We recommend reviewing your integration strategies to align with the currently supported functionalities. For more information, please contact [VTEX support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/multilevel-omnichannel-inventory) is the VTEX setting that allows franchise accounts or white label sellers' inventory to be sold in marketplaces connected to the main account. This article explains how to use the [Change order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/change-order) while performing Multilevel Omnichannel Inventory operations in [external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-guide).\n\nBy configuring this feature, your VTEX store will be able to have orders' items or prices changed when selling products that belong to a franchise account in orders made in external marketplaces. This happens due to a new endpoint is created to receive change order’s notifications sent by a VTEX seller in a Multilevel Omnichannel Inventory operation.\n\nThe image below shows how the process occurs, in more detail:\n\n\n\n## Implementators\n\nThe integration can be implemented by:\n\n* **Integration partner** with the technical ability to implement integrations.\n* **External marketplace** who develops an integration with a VTEX store.\n\nThis article is suitable for both cases.\n\n> The external marketplace must be responsible for the payment process, otherwise the change order in Multilevel Omnichannel Inventory chain orders in external marketplaces operations will be blocked by the Order Management System (OMS).\n\n## Implementation steps\n\nThe feature is implemented as follows:\n\n1. The external marketplace or partner creates an endpoint to receive notifications of order changes in Multilevel Omnichannel Inventory operations in external marketplaces, as specified in [Expected payloads](#expected-payloads). The endpoint must have a base URL followed by `/pvt/orders/{orderGroup}/changes` . \n> For example: `https://www.{{storeName}}.com.br/pvt/orders/orderGroup/changes`.\n2. The external marketplace informs the base URL to VTEX's Order Management System (OMS) when a new order is placed in the external marketplace, by using the `marketplaceServicesEndpoint` field in the [Order placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/order-placement) API.\n3. When an order is changed in the external marketplace, the OMS uses the base URL informed through `marketplaceServicesEndpoint` and concatenates it with `/pvt/orders/{orderGroup}/changes`, so that the endpoint created in step 1 receives notifications about order changes.\n\n> We have considered the `OrderGroup` to build the endpoint because it follows the [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/multilevel-omnichannel-inventory) communication standards.\n\n## Expected payloads\n\nThe endpoint created will have a request body and a response body, as shown in the next sections.\n\n### Request body\n\nThe payload sent to the external marketplace follows the same structure used in the [Register change on order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/registerchange) API. You have an example below:\n\n`1\n\n{ \n\n2\n\n \"reason\": \"Some text about the change. E.g: Add item XPTO\", \n\n3\n\n \"discountValue\": 0, \n\n4\n\n \"incrementValue\": 0, \n\n5\n\n \"itemsRemoved\": [], \n\n6\n\n \"itemsAdded\": [ \n\n7\n\n { \n\n8\n\n \"sellerItemId\": \"8\", \n\n9\n\n \"quantity\": 1, \n\n10\n\n \"price\": 12, \n\n11\n\n \"unitMultiplier\": 1.0000, \n\n12\n\n \"measurementUnit\": \"un\" \n\n13\n\n } \n\n14\n\n ] \n\n15\n\n} \n\n`\n\n| **Field** | **Type** | **Description** |\n| --------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| reason | string | Text explaining why there was a change in the order. This information may be shown to the shopper in the storefront or transactional emails. |\n| discountValue | integer | This field can be used to apply a discount to the total value of the order. Value in cents. |\n| incrementValue | integer | This field can be used to increment the total value of the order. Value in cents. |\n| itemsAdded | array of objects | List of items that should be added to the order. |\n| sellerItemId | string | SKU ID of the item to be added to the order. |\n| quantity | integer | Quantity of items to be added to the order. |\n| price | integer | Total amount in cents of the item to be added to the order. |\n| unitMultiplier | integer | Unit multiplier of the item to be added to the order. |\n| measurementUnit | string | Item's measurement unit. |\n| itemsRemoved | array of objects | List of items that should be removed from the order. Has the same fields of itemsAdded. |\n\n### Response body\n\nThe request returns two types of responses:\n\n* **Response 200 OK:** confirmation and payload as the following example:\n\n`1\n\n{ \n\n2\n\n\"orderId\": \"SLR-v20918230965-01\", \n\n3\n\n\"receipt\": \"61d49ff5-eee4-4093-aba1-1560435dedb0\" \n\n4\n\n} \n\n`\n\n| Field | Type | Description |\n| ------- | ------ | ------------------------------------------------------------------------------------------- |\n| orderId | string | Order ID is a unique code that identifies an order. |\n| receipt | string | Hash for transaction identification or any string that uniquely identifies the transaction. |\n\n* **Response 500 error:** message of failure and there is no payload.\n\nContributors\n\n4\n\n[](https://github.com/anabaarbosa)\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/change-orders-multilevel-omnichannel-inventory-external-marketplaces.md)\n\n[Multilevel omnichannel inventory API integration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces//docs/guides/multilevel-omnichannel-inventory-api-integration)[Pickup pointNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces//docs/guides/setting-up-white-label-seller-as-pickup-point)\n\nContributors\n\n4\n\n[](https://github.com/anabaarbosa)\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[Implementators](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces%23implementators)\n\n[Implementation steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces%23implementation-steps)\n\n[Expected payloads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces%23expected-payloads)\n\n[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces%23request-body)[Response body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces%23response-body)\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/change-orders-multilevel-omnichannel-inventory-external-marketplaces.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Implementators](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces%23implementators)\n\n[Implementation steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces%23implementation-steps)\n\n[Expected payloads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces%23expected-payloads)\n\n[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces%23request-body)[Response body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces%23response-body)\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_5c653eae
|
[
{
"role": "system",
"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 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/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/api-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/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/docs/storefront-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/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/docs/troubleshooting)\n\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/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\nAPI Guides\n\nGet to know our Commerce APIs to extend the VTEX platform and leverage your business.\n\n\n\nGet started\n\nOur core commerce capabilities, provided by over 70 shared microservices, are available for flexible customization through our REST APIs. This enables our clients to integrate third-party solutions into a single platform for all experiences. \n\n\n\nUsing our REST APIs with our serverless development platform (VTEX IO) and scalable data service (Master Data), you can expand the VTEX platform to address your unique business needs.\n\nData orchestration\n\nOur platform orchestrates data through multiple channels and sources to remove barriers and enable more possibilities. E-commerce, Brick-and-mortar, Marketplace, B2B... You name it, we enable it. That is why we are a unified commerce platform for unified businesses.\n\n\n\nCore services\n\nGet to know our core microsservices and leverage your business with our Headless architecture. Our API Guides and Reference cover VTEX Core Services, as illustrated in the image below.\n\nFor details about customizing and composing each service, see our[ Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/composability) guide.\n\nMerchant channels\n\nCDN\n\nWeb Store\n\nPWA\n\nLive Shopping\n\nConversational\n\nMarketplace Out\n\nPersonal Shopper\n\nMobile App\n\nIOT\n\nVTEX Core services\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/catalog-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/checkout-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/promotions-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/pricing-overview)\n\n[Payment Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/payments-overview)\n\n[Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/search-overview)\n\n[Account management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/docs/guides/account-management)\n\nDaaS - Master Data\n\nOMS\n\nSubscriptions\n\nRatings and reviews\n\nCMS\n\nSearch\n\nMessages\n\nLogistics/ Inventory\n\nCustomers\n\nVTEX IO Apps (PaaS)\n\nCustom Admin\n\nCustom store component\n\nCustom backend service (API)\n\nVTEX App\n\n3rd party optional\n\nSearch\n\nPersonalization\n\nRatings and Reviews\n\nLoyalty\n\nAnalytics and Reporting\n\nDXP\n\nCustomer Payments\n\nADA\n\nIntegration Layer\n\nMerchant back office\n\nERP\n\nOMS\n\nWMS\n\nPIM\n\nCRM\n\nData Lake\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_f562e17e
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration invoice tracking in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-guide)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking)\n\nSending invoice and tracking code to the marketplace\n\nWhen integrating orders fulfilled by VTEX sellers, it is important to include tracking codes and invoice data. There are some requirements needed, before connectors can make sure that invoice and tracking code were sent to the marketplace:\n\n* The tracking code and invoice information must be contained within the VTEX Order.\n* Connectors should offer a secure endpoint to receive VTEX notification from our [Retrieve feed order status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/feed) endpoint updating tracking code and invoice data\n* Tracking code and other data about the order’s delivery will only be made available to orders where the seller is in charge of delivery.\n\n## Invoice notification from VTEX\n\nThe invoice sent by VTEX consists of a notification for the connector's URL, with the following structure:\n\n`http://{{marketplaceServicesEndpoint}}/pub/orders/{{orderId}}/invoice`.\n\nIf the connector does not take that into account in their integration, they might receive an error 400 in VTEX's Send Invoice requests.\n\n## Integrating tracking code and invoice data\n\nThe diagram below describes the notification flow, for integrating tracking code and invoice data:\n\nFollow the steps below to integrate them, once receiving the notification. Make sure to review our [Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations) page before you start.\n\n\n\n1. VTEX Orders receive tracking and/or invoice data. This information can be inserted via [Invoice notification from VTEX](#invoice-notification-from-vtex) or manually in VTEX Admin. After receiving invoice information, the order status is updated to invoiced in VTEX. In this case, it is not possible to cancel the order anymore.\n2. VTEX OMS notifies the connector through the URL informed in the [Place Fulfillment Order API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders) by the connector through the property `marketplaceServicesEndpoint`, once the order is inserted in VTEX.\n3. Connector collects information sent through the notification. a. To collect information about **invoice**, use the properties: \n * `invoiceNumber`: invoice’s ID code. \n * `invoiceUrl`: URL that leads to the invoice document. \n * `embeddedInvoice`: invoice document’s XML file. \n * `invoiceValue`: value declared in the invoice. \n * `invoiceKey`: invoice’s key. b. To collect information about **tracking code**, use the properties: \n * `courier`: carrier’s name. \n * `trackingNumber`: number used by the carrier to identify the delivery \n * `trackingUrl`: carrier’s URL used by clients to track the order’s delivery.\n4. Connector transforms the information to the expected format in the marketplace.\n5. Connector sends the information to the marketplace.\n6. Marketplace validates and records information, and responds with a success or failure status.\n7. Connector generates an [Order log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs) for each situation.\n\nNote that:\n\n* An order can have more than one invoice with partial values\n* The tracking code and/or invoice can be filled in at different moments. In this case it is important to understand the flow demanded by the marketplace for sending separate information.\n* Not all fields listed are demanded by the marketplace. Keep in mind to check which ones are in fact mandatory and the correct moment to send them.\n\n> Make sure that all steps are logged as either success or failure, to offer the operation's full traceability. Check out the [Order logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs) page to learn more\n\n## API Reference\n\nUse the endpoints described below to perform this step. It is important to note that when consuming this API, the connector must have a valid VTEX App Key and App Token.\n\n\n\n> All parameters in the endpoints below must be declared in the request. In case one of the parameters does not have a value, you must still send it as `null`.\n\n### Shopping cart simulation\n\nUse the request example below to perform the Shopping Cart Simulation. Check out our [Shopping cart Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation) API Reference to know more details.\n\n`1\n\n{ \n\n2\n\n\"items\":[ \n\n3\n\n{...} \n\n4\n\n] \n\n5\n\n\"ratesAndBenefitsData\":{ \n\n6\n\n\"rateAndBenefitsIdentifiers\":[] \n\n7\n\n\"teaser\":[] \n\n8\n\n} \n\n9\n\n\"paymentData\":{ \n\n10\n\n\"installmentOptions\":[...] \n\n11\n\n\"paymentSystems\":[...] \n\n12\n\n\"payments\":[] \n\n13\n\n\"giftCards\":[] \n\n14\n\n\"giftCardMessages\":[] \n\n15\n\n\"availableAccounts\":[] \n\n16\n\n\"availableTokens\":[] \n\n17\n\n} \n\n18\n\n\"selectableGifts\":[] \n\n19\n\n\"marketingData\":NULL \n\n20\n\n\"postalCode\":NULL \n\n21\n\n\"country\":\"BRA\" \n\n22\n\n\"logisticsInfo\":[ \n\n23\n\n{...} \n\n24\n\n] \n\n25\n\n\"messages\":[] \n\n26\n\n\"purchaseConditions\":{ \n\n27\n\n\"itemPurchaseConditions\":[...] \n\n28\n\n} \n\n29\n\n\"pickupPoints\":[] \n\n30\n\n\"subscriptionData\":NULL \n\n31\n\n\"totals\":[ \n\n32\n\n{...} \n\n33\n\n] \n\n34\n\n\"itemMetadata\":NULL \n\n35\n\n} \n\n`\n\n### Place fulfillment order\n\nUse the request example below to place fulfillment order. Check out our [Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders) API Reference to know more details.\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"items\": [ \n\n4\n\n { \n\n5\n\n \"id\": \"1\", \n\n6\n\n \"price\": 900, \n\n7\n\n \"quantity\": 1, \n\n8\n\n \"seller\": \"1\" \n\n9\n\n } \n\n10\n\n ], \n\n11\n\n \"isCreatedAsync\": true, \n\n12\n\n \"marketplaceOrderGroup\" : \"794901324\", \n\n13\n\n \"marketplaceOrderId\": \"2630580124\", \n\n14\n\n \"marketplacePaymentValue\": 1100, \n\n15\n\n \"marketplacePaymentReferenceValue\": 1100, \n\n16\n\n \"marketplaceServicesEndpoint\": \"http://skyhubintegration.vtexinternal.com/api/skyhubintegration/commercialcondition?an=grocery1\", \n\n17\n\n \"clientProfileData\": { \n\n18\n\n \"CorporateDocument\": null, //Cnpj \n\n19\n\n \"CorporateName\": null, //nome da empresa \n\n20\n\n \"CorporatePhone\": null, // ddd+telefone \n\n21\n\n \"Document\": \"14310315771\", //cpf \n\n22\n\n \"DocumentType\": null, //se pessoa fisica, colocar CPF, senão CNPJ \n\n23\n\n \"Email\": \"conta@dominio.com.br\", \n\n24\n\n \"FirstName\": \"Nome\", \n\n25\n\n \"IsCorporate\": false, //caso pessoa juridica o valor deve ser true \n\n26\n\n \"LastName\": \"Sobrenome\", \n\n27\n\n \"Phone\": \"41998718616\", \n\n28\n\n \"StateInscription\": null, //inscrição estadual \n\n29\n\n \"TradeName\": null, \n\n30\n\n \"UserProfileId\": null //utilizado somente com pedidos VTEX \n\n31\n\n }, \n\n32\n\n \"shippingData\": { \n\n33\n\n \"address\": { \n\n34\n\n \"addressId\": \"Casa\", \n\n35\n\n \"addressType\": \"Residencial\", \n\n36\n\n \"receiverName\": \"Marcelo\", \n\n37\n\n \"city\": \"Curitiba\", \n\n38\n\n \"complement\": null, \n\n39\n\n \"country\": \"BRA\", \n\n40\n\n \"geoCoordinates\": [], \n\n41\n\n \"neighborhood\": \"Novo Mundo\", \n\n42\n\n \"number\": \"4000\", \n\n43\n\n \"postalCode\": \"81020230\", \n\n44\n\n \"reference\": null, \n\n45\n\n \"state\": \"PR\", \n\n46\n\n \"street\": \"Rua Eduardo Carlos Pereira\" \n\n47\n\n }, \n\n48\n\n \"logisticsInfo\": [ \n\n49\n\n { \n\n50\n\n \"itemIndex\": 0, \n\n51\n\n \"price\": 200, \n\n52\n\n \"selectedDeliveryChannel\":\"delivery\", \n\n53\n\n \"selectedSla\": null, \n\n54\n\n \"lockTTL\": \"1d\", //tempo para reserva do estoque do pedido \n\n55\n\n \"shippingEstimate\":\"1d\" //tempo de entrega do pedido \n\n56\n\n } \n\n57\n\n ], \n\n58\n\n \"selectedAddresses\":[ \n\n59\n\n { \n\n60\n\n \"addressType\": \"Residencial\", \n\n61\n\n \"receiverName\": \"Henrique Vianna\", \n\n62\n\n \"addressId\": \"2\", \n\n63\n\n \"postalCode\": \"81020-235\", \n\n64\n\n \"city\": \"Curitiba\", \n\n65\n\n \"state\": \"PR\", \n\n66\n\n \"country\": \"BRA\", \n\n67\n\n \"street\": \"Rua Eduardo Carlos Pereira\", \n\n68\n\n \"number\": \"4125\", \n\n69\n\n \"neighborhood\": \"Portão\", \n\n70\n\n \"complement\": \"\", \n\n71\n\n \"reference\": null, \n\n72\n\n \"geoCoordinates\": [ \n\n73\n\n -49.2892059, \n\n74\n\n -25.4826319 \n\n75\n\n ] \n\n76\n\n }], \n\n77\n\n \"isFob\": false //se entrega feita pelo lojista coloque false, senão true \n\n78\n\n }, \n\n79\n\n \"customData\": { \n\n80\n\n \"customApps\": [{ \n\n81\n\n \"fields\": { \n\n82\n\n \"orderIdMarketplace\": \"2630580148\", \n\n83\n\n \"paymentIdMarketplace\": \"8191598627\" \n\n84\n\n }, \n\n85\n\n \"id\": \"marketplace-integration\", \n\n86\n\n \"major\": 1 \n\n87\n\n }] \n\n88\n\n }, \n\n89\n\n \"openTextField\": { \n\n90\n\n \"value\": \"{\\\"Phones\\\":[\\\"21998718616\\\"]}\" \n\n91\n\n } \n\n92\n\n } \n\n93\n\n] \n\n`\n\n### Authorize dispatch\n\nUse the request example below to authorize dispatch. Check out our [Authorize Dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders/-orderId-/fulfill)API Reference to know more details.\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"marketplaceOrderId\": \"956\" \n\n4\n\n } \n\n5\n\n] \n\n`\n\nContributors\n\n4\n\n[](https://github.com/RuanUFSC)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-invoice-tracking.md)\n\n[How to validate if items are available for delivery« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking//docs/guides/external-marketplace-integration-delivery-validation)[How to update a canceled order’s status in VTEXNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking//docs/guides/external-marketplace-integration-canceled-orders)\n\nContributors\n\n4\n\n[](https://github.com/RuanUFSC)\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[Invoice notification from VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23invoice-notification-from-vtex)\n\n[Integrating tracking code and invoice data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23integrating-tracking-code-and-invoice-data)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23api-reference)\n\n[Shopping cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23shopping-cart-simulation)[Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23place-fulfillment-order)[Authorize dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23authorize-dispatch)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-invoice-tracking.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Invoice notification from VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23invoice-notification-from-vtex)\n\n[Integrating tracking code and invoice data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23integrating-tracking-code-and-invoice-data)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23api-reference)\n\n[Shopping cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23shopping-cart-simulation)[Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23place-fulfillment-order)[Authorize dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-invoice-tracking/docs/guides/external-marketplace-integration-invoice-tracking%23authorize-dispatch)\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_a1c652bf
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore developing and overriding components creating a new section in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/overrides-overview)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)\n\n[List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\n\n[Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/overrides-overview)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)\n\n[List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\n\n[Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-overview)\n\nCreating a new section\n\nIn this guide, you will learn how to create a new section for your storefront and make it available in the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview). This solution is useful when your project requires a section not natively available in FastStore.\n\nFor this guide, we will create two sections:\n\n* `Call to Action` Gets a specific action from the user.\n* `OurStores`: Indicates the closest store for the user. \n> Sections are page components that wrap up other components, enabling you to create cohesive and functional content for your store. For example, the Hero section is a native section that includes the following components: `Hero`, `HeroImage`, and `HeroHeader`.\n\n## Before you begin\n\n### 1\\. Integrate the store with the Headless CMS\n\nAll sections must be available in the Headless CMS so they can be added and managed on your store's pages. To integrate your FastStore project, please refer to the [Headless CMS integration track](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account).\n\n### 2\\. Knowledge of how sections and content types work on Headless CMS\n\nDuring the creation of a new section, you will create files such as `sections.json` and `content-types.json`, which follow a structure established for the Headless CMS.\n\n### 3\\. Install the FastStore CLI\n\nMake sure to install the FastStore CLI to use its commands locally. Refer to the [FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli) guide for more information.\n\n## `Call to Action`\n\n### Step 1: Creating folders and files related to the Headless CMS\n\n1. In the FastStore root directory, create a folder named `cms`.\n2. Inside `cms`, create the `faststore` folder.\n3. Within the `cms/faststore` folder, create `sections.json` file.\n4. In the `sections.json` file, add the new section that you want to display in the Headless CMS. The schema below defines how the Headless CMS renders a section:\n\nsections.json\n\n`1\n\n [ \n\n2\n\n { \n\n3\n\n \"name\": \"CallToAction\", \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Call To Action\", \n\n6\n\n \"description\": \"Get your 20% off on the first purchase!\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [ \n\n9\n\n \"title\", \n\n10\n\n \"link\" \n\n11\n\n ], \n\n12\n\n \"properties\": { \n\n13\n\n \"title\": { \n\n14\n\n \"title\": \"Title\", \n\n15\n\n \"type\": \"string\" \n\n16\n\n }, \n\n17\n\n \"link\": { \n\n18\n\n \"title\": \"Link Path\", \n\n19\n\n \"type\": \"object\", \n\n20\n\n \"required\": [ \n\n21\n\n \"text\", \n\n22\n\n \"url\" \n\n23\n\n ], \n\n24\n\n \"properties\": { \n\n25\n\n \"text\": { \n\n26\n\n \"title\": \"Text\", \n\n27\n\n \"type\": \"string\" \n\n28\n\n }, \n\n29\n\n \"url\": { \n\n30\n\n \"title\": \"URL\", \n\n31\n\n \"type\": \"string\" \n\n32\n\n } \n\n33\n\n } \n\n34\n\n } \n\n35\n\n } \n\n36\n\n } \n\n37\n\n } \n\n38\n\n ] \n\n`\n\n> This new section receives a title and a link pointing to a specific location.\n\n### Step 2: Creating the new section\n\nTo render the `CallToAction` section you created in the previous step, you need to create this section component.\n\n1. If you don't already have it, create a folder named `components` inside the `src` directory.\n2. Inside the `components` folder, create a file named `CallToAction.tsx` and add the following code:\n\nsrc/components/CallToAction.tsx\n\n`1\n\nimport React from \"react\"; \n\n2\n\n \n3\n\nexport interface CallToActionProps { \n\n4\n\n title: string; \n\n5\n\n link: { \n\n6\n\n text: string; \n\n7\n\n url: string; \n\n8\n\n }; \n\n9\n\n} \n\n10\n\n \n11\n\nexport default function CallToAction(props: CallToActionProps) { \n\n12\n\n return ( \n\n13\n\n <section> \n\n14\n\n <h2>{props.title}</h2> \n\n15\n\n <a href={props.link.url}>{props.link.text}</a> \n\n16\n\n </section> \n\n17\n\n ); \n\n18\n\n} \n\n`\n\nThis section will receive the `link` and `title` defined previously in the `sections.json` file.\n\n1. Create a file named `index.tsx` inside the components folder.\n\n> The `index.tsx` file provides an entry point for importing and using the `CallToAction` component. It acts as a container for all the components within the components folder and allows for easier organization and reusability of code.\n\nOpen the `index.tsx` file and add the following code:\n\nsrc/components/index.tsx\n\n`1\n\nimport CallToAction from './CallToAction' \n\n2\n\n \n3\n\nexport default { CallToAction } \n\n`\n\n### Step 3: Synchronizing the new section with the Headless CMS\n\n1. In the terminal, run `faststore cms-sync`. This command will synchronize the new section you created with the CMS.\n2. Go to the VTEX Admin and access **Storefront > Headless CMS**.\n3. Click on the `Page` content type.\n\n\n\n1. In the `Sections` tab, click the `+`, search for the new `Call to Action` section, and add it to your page.\n\n\n\n## `OurStore`\n\n1. After [creating the files and folders](#step-1-creating-folders-and-files-related-to-the-headless-cms), In the `sections.json` file, add the new section that you want to display in the Headless CMS. The schema below defines how the Headless CMS renders the `OurStores` section that we will use in the example:\n\nsections.json\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"name\": \"OurStores\", \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Our Stores\", \n\n6\n\n \"description\": \"Search stores near to the users\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [\"title\", \"description\"], \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 \"default\": \"Explore Nearby Stores\" \n\n14\n\n }, \n\n15\n\n \"description\": { \n\n16\n\n \"title\": \"Link Path\", \n\n17\n\n \"type\": \"string\", \n\n18\n\n \"default\": \"Discover the closest store to you and pay us a visit.\" \n\n19\n\n } \n\n20\n\n } \n\n21\n\n } \n\n22\n\n } \n\n23\n\n] \n\n`\n\n1. Inside the `components` folder, create a file named `OurStores.tsx` and add the following code:\n\nsrc/components/OurStores.tsx\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { Button, Icon, SelectField } from '@faststore/ui' \n\n3\n\n \n4\n\nexport interface OurStoresProps { \n\n5\n\n title: string \n\n6\n\n description: string \n\n7\n\n} \n\n8\n\n \n9\n\nexport default function OurStores(props: OurStoresProps) { \n\n10\n\n return ( \n\n11\n\n <section> \n\n12\n\n <h2>{props.title}</h2> \n\n13\n\n <p>{props.description}</p> \n\n14\n\n <div> \n\n15\n\n <SelectField \n\n16\n\n id=\"select-state-store\" \n\n17\n\n label=\"State:\" \n\n18\n\n options={{ \n\n19\n\n newYork: 'New York', \n\n20\n\n arizona: 'Arizona', \n\n21\n\n massachusetts: 'Massachusetts', \n\n22\n\n hawaii: 'Hawaii', \n\n23\n\n }} \n\n24\n\n /> \n\n25\n\n <SelectField \n\n26\n\n id=\"select-city-store\" \n\n27\n\n label=\"City:\" \n\n28\n\n options={{ \n\n29\n\n newYorkCity: 'New York City', \n\n30\n\n phoenix: 'Phoenix', \n\n31\n\n boston: 'Boston', \n\n32\n\n honolulu: 'Honolulu', \n\n33\n\n }} \n\n34\n\n /> \n\n35\n\n <Button \n\n36\n\n variant=\"secondary\" \n\n37\n\n icon={<Icon name=\"ArrowRight\" />} \n\n38\n\n iconPosition=\"right\" \n\n39\n\n > \n\n40\n\n Find Store \n\n41\n\n </Button> \n\n42\n\n </div> \n\n43\n\n </section> \n\n44\n\n ) \n\n45\n\n} \n\n`\n\nFor this section, we will use the following components from the Faststore UI: [Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button), [Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon) and [SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules/select-field).\n\n1. Create a file named `index.tsx` inside the components folder, and add the following code:\n\nsrc/components/index.tsx\n\n`1\n\nimport OurStores from './OurStores' \n\n2\n\n \n3\n\nexport default { OurStores } \n\n`\n\n1. Repeat the steps in [Step 3: Synchronizing the new section with the Headless CMS](#step3-synchronizing-the-new-section-with-the-headless-cms), and you should see the new section but without styles as in the example below:\n\n\n\nTo add styles to `OurStore`, refer to the following section [Importing styles when creating a new section](#importing-styles-when-creating-a-new-section).\n\n## Adding styles to a new section\n\nAfter creating a new section, you can style it to match your store's branding. Follow the steps below using the [OurStores](#ourstores) section as an example.\n\n### Instructions\n\n1. In your store code, open the `components` folder and create a `.module.scss` file for your component. For example, if your component is `OurStores`, name the file `ourStores.module.scss`. This file will contain the styles specific to this section.\n2. Import the necessary FastStore UI styles into your `.module.scss` file. For example, to style the `OurStores` component, we imported the styles for the [Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button) and [SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field) components. The `Select` styles are also imported since `SelectField` inherits them.\n\n`1\n\n.ourStores { \n\n2\n\n @import '@faststore/ui/src/components/atoms/Button/styles.scss'; \n\n3\n\n @import '@faststore/ui/src/components/atoms/Select/styles.scss'; \n\n4\n\n @import '@faststore/ui/src/components/molecules/SelectField/styles.scss'; \n\n5\n\n} \n\n`\n\n1. Open the component's `.tsx` file. For example, `OurStores.tsx`.\n2. Import the newly created stylesheet into the component:\n\n```` 1\n\nimport React from 'react' \n\n2\n\nimport { Button, Icon, SelectField } from '@faststore/ui' \n\n3\n\n \n4\n\nimport styles from './ourStores.module.scss' ``` \n\n5\n\n \n6\n\n5. Apply the styles to your components using `className={styles.<className>}`. Replace `<className>` with the appropriate class name defined in your stylesheet. For example: \n\n7\n\n ```tsx mark=13 \n\n8\n\n import React from 'react' \n\n9\n\n import { Button, Icon, SelectField } from '@faststore/ui' \n\n10\n\n \n11\n\n import styles from './ourStores.module.scss' \n\n12\n\n \n13\n\n export interface OurStoresProps { \n\n14\n\n title: string \n\n15\n\n description: string \n\n16\n\n } \n\n17\n\n \n18\n\n export default function OurStores(props: OurStoresProps) { \n\n19\n\n return ( \n\n20\n\n <section className={styles.ourStores}> \n\n21\n\n <h2>{props.title}</h2> \n\n22\n\n <p>{props.description}</p> \n\n23\n\n <div> \n\n24\n\n <SelectField \n\n25\n\n id=\"select-state-store\" \n\n26\n\n label=\"State:\" \n\n27\n\n options={{ \n\n28\n\n newYork: 'New York', \n\n29\n\n arizona: 'Arizona', \n\n30\n\n massachusetts: 'Massachusetts', \n\n31\n\n hawaii: 'Hawaii', \n\n32\n\n }} \n\n33\n\n /> \n\n34\n\n <SelectField \n\n35\n\n id=\"select-city-store\" \n\n36\n\n label=\"City:\" \n\n37\n\n options={{ \n\n38\n\n newYorkCity: 'New York City', \n\n39\n\n phoenix: 'Phoenix', \n\n40\n\n boston: 'Boston', \n\n41\n\n honolulu: 'Honolulu', \n\n42\n\n }} \n\n43\n\n /> \n\n44\n\n <Button \n\n45\n\n variant=\"secondary\" \n\n46\n\n icon={<Icon name=\"ArrowRight\" />} \n\n47\n\n iconPosition=\"right\" \n\n48\n\n > \n\n49\n\n Find Store \n\n50\n\n </Button> \n\n51\n\n </div> \n\n52\n\n </section> \n\n53\n\n ) \n\n54\n\n } \n\n ````\n\n1. Open the terminal and run `yarn dev` to see your changes.\n\n\n\n1. Add more styles to the section by using [design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-overview%23global-tokens) and [component-specific data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button%23customization) to the `.module.scss` file:\n\n`1\n\n.ourStores { \n\n2\n\n @import '@faststore/ui/src/components/atoms/Button/styles.scss'; \n\n3\n\n @import '@faststore/ui/src/components/atoms/Select/styles.scss'; \n\n4\n\n @import '@faststore/ui/src/components/molecules/SelectField/styles.scss'; \n\n5\n\n \n6\n\n width: 100%; \n\n7\n\n display: flex; \n\n8\n\n flex-direction: column; \n\n9\n\n justify-content: center; \n\n10\n\n align-items: center; \n\n11\n\n padding: var(--fs-spacing-5); \n\n12\n\n margin: auto; \n\n13\n\n background-color: var(--fs-color-neutral-bkg); \n\n14\n\n \n15\n\n [data-fs-select-field] { \n\n16\n\n flex-direction: column; \n\n17\n\n align-items: flex-start; \n\n18\n\n \n19\n\n [data-fs-select] { \n\n20\n\n border: var(--fs-border-width) solid var(--fs-border-color); \n\n21\n\n margin-top: var(--fs-spacing-0); \n\n22\n\n width: 10rem; \n\n23\n\n height: var(--fs-control-min-height); \n\n24\n\n \n25\n\n select { \n\n26\n\n width: 100%; \n\n27\n\n } \n\n28\n\n } \n\n29\n\n } \n\n30\n\n} \n\n31\n\n \n32\n\n.ourStores__title { \n\n33\n\n font-size: var(--fs-text-size-title-section); \n\n34\n\n margin-bottom: var(--fs-spacing-1); \n\n35\n\n} \n\n36\n\n \n37\n\n.ourStores__content { \n\n38\n\n display: flex; \n\n39\n\n align-items: flex-end; \n\n40\n\n column-gap: var(--fs-spacing-5); \n\n41\n\n margin: var(--fs-spacing-5); \n\n42\n\n} \n\n`\n\n1. Update the component's file by adding the appropriate CSS classes to elements, ensuring they align with the newly defined styles in your stylesheet. For example:\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { Button, Icon, SelectField } from '@faststore/ui' \n\n3\n\n \n4\n\nimport styles from './ourStores.module.scss' \n\n5\n\n \n6\n\nexport interface OurStoresProps { \n\n7\n\n title: string \n\n8\n\n description: string \n\n9\n\n} \n\n10\n\n \n11\n\nexport default function OurStores(props: OurStoresProps) { \n\n12\n\n return ( \n\n13\n\n <section className={styles.ourStores}> \n\n14\n\n <h2 className={styles.ourStores__title}>{props.title}</h2> \n\n15\n\n <p>{props.description}</p> \n\n16\n\n <div className={styles.ourStores__content}> \n\n17\n\n <SelectField \n\n18\n\n id=\"select-state-store\" \n\n19\n\n label=\"State:\" \n\n20\n\n options={{ \n\n21\n\n newYork: 'New York', \n\n22\n\n arizona: 'Arizona', \n\n23\n\n massachusetts: 'Massachusetts', \n\n24\n\n hawaii: 'Hawaii', \n\n25\n\n }} \n\n26\n\n /> \n\n27\n\n <SelectField \n\n28\n\n id=\"select-city-store\" \n\n29\n\n label=\"City:\" \n\n30\n\n options={{ \n\n31\n\n newYorkCity: 'New York City', \n\n32\n\n phoenix: 'Phoenix', \n\n33\n\n boston: 'Boston', \n\n34\n\n honolulu: 'Honolulu', \n\n35\n\n }} \n\n36\n\n /> \n\n37\n\n <Button \n\n38\n\n variant=\"secondary\" \n\n39\n\n icon={<Icon name=\"ArrowRight\" />} \n\n40\n\n iconPosition=\"right\" \n\n41\n\n > \n\n42\n\n Find Store \n\n43\n\n </Button> \n\n44\n\n </div> \n\n45\n\n </section> \n\n46\n\n ) \n\n47\n\n} \n\n`\n\n1. Navigate to `http://localhost:3000` in your browser to see the updated component with the applied styles.\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/creating-a-new-section.mdx)\n\n[Adding an image to the Alert component« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides//faststore/override-use-cases-adding-an-image-to-the-alert-component)[List of native sections and overridable componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\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/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23before-you-begin)\n\n[1\\. Integrate the store with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%231-integrate-the-store-with-the-headless-cms)[2\\. Knowledge of how sections and content types work on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%232-knowledge-of-how-sections-and-content-types-work-on-headless-cms)[3\\. Install the FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%233-install-the-faststore-cli)\n\n[Call to Action](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23call-to-action)\n\n[Step 1: Creating folders and files related to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-1-creating-folders-and-files-related-to-the-headless-cms)[Step 2: Creating the new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-2-creating-the-new-section)[Step 3: Synchronizing the new section with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-3-synchronizing-the-new-section-with-the-headless-cms)\n\n[OurStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23ourstore)\n\n[Adding styles to a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23adding-styles-to-a-new-section)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%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/creating-a-new-section.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/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23before-you-begin)\n\n[1\\. Integrate the store with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%231-integrate-the-store-with-the-headless-cms)[2\\. Knowledge of how sections and content types work on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%232-knowledge-of-how-sections-and-content-types-work-on-headless-cms)[3\\. Install the FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%233-install-the-faststore-cli)\n\n[Call to Action](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23call-to-action)\n\n[Step 1: Creating folders and files related to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-1-creating-folders-and-files-related-to-the-headless-cms)[Step 2: Creating the new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-2-creating-the-new-section)[Step 3: Synchronizing the new section with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-3-synchronizing-the-new-section-with-the-headless-cms)\n\n[OurStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23ourstore)\n\n[Adding styles to a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23adding-styles-to-a-new-section)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%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_be56a965
|
[
{
"role": "system",
"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 lucky orange 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.lucky-orange/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/api-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.lucky-orange/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.lucky-orange/docs/storefront-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.lucky-orange/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.lucky-orange/docs/troubleshooting)\n\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.lucky-orange/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/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.lucky-orange/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/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.lucky-orange/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.lucky-orange/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/guides/pixel-apps)\n\nLucky Orange\n\nOfficial extension\n\nVersion: 1.0.1\n\nLatest version: 1.0.1\n\nLucky Orange first-party app.\n\n## How to install\n\nOpen the VTEX App Store and install this app on your store.\n\nNow, open the app settings on your admin and fill your Lucky Orange\\`s Site ID.\n\n[LogRocket« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.logrocket)[Search ConsoleNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.google-search-console)\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[How to install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.lucky-orange/docs/apps/vtex.lucky-orange%23how-to-install)\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_4b6a11bf
|
[
{
"role": "system",
"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 enabling manual prices for subscriptions v3 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/enabling-manual-prices-for-subscriptions-v3/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/api-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/enabling-manual-prices-for-subscriptions-v3/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/enabling-manual-prices-for-subscriptions-v3/docs/storefront-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/enabling-manual-prices-for-subscriptions-v3/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/enabling-manual-prices-for-subscriptions-v3/docs/troubleshooting)\n\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/enabling-manual-prices-for-subscriptions-v3/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/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/enabling-manual-prices-for-subscriptions-v3/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/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/enabling-manual-prices-for-subscriptions-v3/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/actions-orders)\n\nSubscriptions\n\n[Enabling Manual Prices for Subscriptions v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3)\n\n[How to keep attachments from original orders in subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions)\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/enabling-manual-prices-for-subscriptions-v3/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/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/enabling-manual-prices-for-subscriptions-v3/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/enabling-manual-prices-for-subscriptions-v3/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/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/enabling-manual-prices-for-subscriptions-v3/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/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/enabling-manual-prices-for-subscriptions-v3/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/actions-orders)\n\nSubscriptions\n\n[Enabling Manual Prices for Subscriptions v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3)\n\n[How to keep attachments from original orders in subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions)\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/enabling-manual-prices-for-subscriptions-v3/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/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/enabling-manual-prices-for-subscriptions-v3/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/enabling-manual-prices-for-subscriptions-v3/docs/guides)\n\nOrders\n\nSubscriptions\n\n[Enabling Manual Prices for Subscriptions v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3)\n\nEnabling Manual Prices for Subscriptions v3\n\n> The option of setting manual prices is only available for Subscriptions v3\\. If you are using a previous version of the Subscriptions system, check out the [Subscriptions v3 migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/subscriptions-v3-migration-guide).\n\n**Subscriptions** is an app developed by VTEX to facilitate recurring sales in your store. It works as an automatic scheduler, executing a repurchase at the frequency requested by the customer. Check out our article [How subscriptions work](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-subscriptions-work--frequentlyAskedQuestions%5F4453) to know more.\n\nWhen using subscriptions, stores might need to configure prices manually for each item. Considering that product prices can change over time, maintaining the same commercial rules for subscription orders can be a good strategy to retain clients over a longer period.\n\nBy enabling the Manual Price feature for Subscriptions v3, you can:\n\n* Apply a manual price on each subscription item instead of the current price applied.\n* Maintain the same manual price for every future recurrent order from that subscription, if desired.\n\n## Before you begin\n\nTo enable Manual Prices for Subscriptions v3, it is first necessary to enable it in the Checkout settings. This means you must make a request to the post [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updateorderformconfiguration) endpoint, setting `allowManualPrices` to `true`, if you have not done this yet. For more information on how manual prices work at VTEX, we recommend reading [Enabling Manual Price in my store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price).\n\nSetting Manual Prices for Subscriptions generally follows the same rules as applying manual prices to items in regular orders at Checkout. Still, it requires additional configurations and actions detailed in the following sections.\n\nTo apply manual prices, users must have at least one of the following [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) or [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3):\n\n* Owner (Admin Super) role\n* Call Center Operator (Telesales) role\n* Shopping Cart Full Access resource\n\n## Configuration\n\nTo enable Manual Prices for Subscriptions, you must follow the steps below:\n\n1. Make a request using the get [Get Subscription Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getsettings-1) endpoint to retrieve the current settings related to Subscriptions in your store.\n2. Make a request using the post [Edit Subscription Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/editsettings-1) endpoint, setting the following properties to `true`:\n\n| **Property name** | **Type** | **Description** |\n| ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| manualPriceAllowed | boolean | This property enables the manual price configuration in subscription items when set to true. This is valid for all existing subscriptions, provided that there is a manual price configured. |\n| useItemPriceFromOriginalOrder | boolean | This property enables using the price manually set for each item from the original subscription order when set to true. This is only valid for new subscriptions created after enabling this configuration. The manualPriceAllowed property must also be set to true; otherwise, this configuration will not work. |\n\n#### Request body example\n\n`1\n\n{ \n\n2\n\n \"slaOption\": \"NONE\", \n\n3\n\n \"defaultSla\": null, \n\n4\n\n \"isUsingV3\": true, \n\n5\n\n \"onMigrationProcess\": false, \n\n6\n\n \"executionHourInUtc\": 9, \n\n7\n\n \"workflowVersion\": \"1.1\", \n\n8\n\n \"deliveryChannels\": [ \n\n9\n\n \"delivery\" \n\n10\n\n ], \n\n11\n\n \"randomIdGeneration\": false, \n\n12\n\n \"isMultipleInstallmentsEnabledOnCreation\": false, \n\n13\n\n \"isMultipleInstallmentsEnabledOnUpdate\": false, \n\n14\n\n \"orderCustomDataAppId\": null, \n\n15\n\n \"postponeExpiration\": false, \n\n16\n\n \"manualPriceAllowed\": true, \n\n17\n\n \"useItemPriceFromOriginalOrder\": true \n\n18\n\n} \n\n`\n\n## Setting a manual price in a subscription item\n\nTo apply a manual price to a subscription item, you must insert a new value into the `manualPrice` property:\n\n| **Property name** | **Type** | **Description** |\n| ----------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| manualPrice | int32 | The manual price you want to use for the subscription item. The value follows the same format as in Checkout, which means you must send it without decimal separators. Examples: If the desired value is 29.90, you must write 2990. In case the value is 0.90, you must write 90. |\n\nYou can manually modify the price when:\n\n* [Adding an item to a subscription](#adding-an-item-to-a-subscription).\n* [Editing an item in a subscription](#editing-an-item-in-a-subscription).\n\nRead the following sections for details on the endpoints you must use and their request body examples.\n\n> 🚧 You can only apply a manual price to a subscription item if the `manualPriceAllowed` configuration is set to `true`, as described in the [Configuration](#configuration) section.\n\n### Adding an item to a subscription\n\nWhen making a post [Add item to subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/post%5Fapi-rns-pub-subscriptions-id-items) request, you can apply a manual price by informing a new value in the `manualPrice` property in the request body.\n\n#### Request body example\n\n`1\n\n{ \n\n2\n\n \"skuId\": \"12\", \n\n3\n\n \"quantity\": 5, \n\n4\n\n \"manualPrice\": 40 \n\n5\n\n} \n\n`\n\n### Editing an item in a subscription\n\nTo apply a manual price when making a patch [Edit item on subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/patch%5Fapi-rns-pub-subscriptions-id-items-itemid) request, you must inform the desired value in the `manualPrice` property in the request body.\n\nKeep in mind that all the other editable properties — `status`, `isSkipped`, and `quantity` — remain with the same behavior and can be set in the same request to edit the subscription item as the `manualPrice`.\n\n#### Request body example\n\n`1\n\n{ \n\n2\n\n \"quantity\": 5, \n\n3\n\n \"manualPrice\": 500 \n\n4\n\n} \n\n`\n\n### Removing a manual price in a subscription item\n\nTo remove a manual price, you must set the `manualPrice` value to `null` when making a patch [Edit item on subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/patch%5Fapi-rns-pub-subscriptions-id-items-itemid) request.\n\n#### Request body example\n\n`1\n\n{ \n\n2\n\n \"manualPrice\": null \n\n3\n\n} \n\n`\n\nAnother option is to completely remove the item from the subscription, making a request to the delete [Remove item from subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/delete%5Fapi-rns-pub-subscriptions-id-items-itemid) endpoint.\n\nContributors\n\n2\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/Subscriptions/enabling-manual-prices-for-subscriptions-v3.md)\n\n[Adding a second address for invoicing an order« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3//docs/guides/adding-a-second-address-to-the-order)[How to keep attachments from original orders in subscriptionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3//docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23before-you-begin)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23configuration)\n\n[Setting a manual price in a subscription item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23setting-a-manual-price-in-a-subscription-item)\n\n[Adding an item to a subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23adding-an-item-to-a-subscription)[Editing an item in a subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23editing-an-item-in-a-subscription)[Removing a manual price in a subscription item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23removing-a-manual-price-in-a-subscription-item)\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/Subscriptions/enabling-manual-prices-for-subscriptions-v3.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/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23before-you-begin)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23configuration)\n\n[Setting a manual price in a subscription item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23setting-a-manual-price-in-a-subscription-item)\n\n[Adding an item to a subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23adding-an-item-to-a-subscription)[Editing an item in a subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23editing-an-item-in-a-subscription)[Removing a manual price in a subscription item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3/docs/guides/enabling-manual-prices-for-subscriptions-v3%23removing-a-manual-price-in-a-subscription-item)\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_27a9461d
|
[
{
"role": "system",
"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 6 buildingyourownstoretheme 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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/docs/api-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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/docs/storefront-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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/docs/troubleshooting)\n\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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/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-6-buildingyourownstoretheme/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/docs/guides/store-framework)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/docs/guides/getting-started-3)\n\n[6\\. Building your own store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)\n\n6\\. Building your own Store Theme\n\nExplore resources to personalize your VTEX store with Store Framework.\n\nAfter completing the initial setup, creating your Store Theme project, and learning how to customize your store pages, you can start implementing advanced personalization for your store.\n\nUnder the [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework) category, you'll find a set of guides to help you customize your storefront:\n\n* [Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages): Create different types of pages tailored to your business needs.\n* [Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components): Build your storefront, from basic elements to advanced customizations, by leveraging VTEX IO Store Framework components.\n* [Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-advanced-layouts): Create advanced layouts in your Store Framework store.\n* [Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor): Customize your Store Framework storefront by using Site Editor.\n* [Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling): Customize your store layout with Store Framework.\n\nYou can also access our [hands-on course on the VTEX Store Framework](https://read.calvincode.net/reader?url=https://learn.vtex.com/page/learning-path-lang-en).\n\n> To foster constructive collaboration among developers, facilitate version monitoring, and improve the visibility of your Store Theme app, use code versioning tools such as GitHub. Learn more in [Best practices on workspace management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices).\n\nOnce you've finished customizing your storefront, whether by completing the hands-on course or following our guides, remember that your Store Theme app is still stored locally on your computer and linked to your VTEX store only through the development workspace. To make your changes visible to end users, you need to [make your theme content public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public).\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-6-buildingyourownstoretheme.md)\n\n[5\\. Defining styles« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme//docs/guides/vtex-io-documentation-5-definingstyles)[7\\. Making your store theme publicNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme//docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\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/Getting-Started/getting-started-3/vtex-io-documentation-6-buildingyourownstoretheme.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_c7f9c6e7
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides storefront seo in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-performance)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-performance)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/storefront-development)\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-best-practices)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo)\n\nSEO\n\nDiscover strategies to improve your ecommerce SEO.\n\nSearch Engine Optimization (SEO) is a set of strategies to enhance the performance of websites, blogs, and web pages. The primary goal is to achieve higher rankings in organic search results, driving more traffic and boosting the site's authority.\n\nIn ecommerce, a well-implemented SEO strategy enhances visibility, attracts organic traffic, and improves user experience. By elevating search engine rankings, SEO provides a competitive edge, reduces customer acquisition costs, and ensures long-term results.\n\nTo learn more about SEO strategies, check Google’s documentation resource [Explore Google Search documentation to improve your site's SEO](https://read.calvincode.net/reader?url=https://developers.google.com/search/docs).\n\nVTEX offers a set of tools and settings that allow you to optimize your store for search engines, making your products more discoverable and improving site performance.\n\nIn this guide, you will learn some best practices for implementing strategies to improve SEO in your VTEX store. It is divided into [general best practices](#general-seo-best-practices) applicable to all storefronts, followed by specific configurations for [FastStore](#faststore), [Store Framework](#store-framework), and [(Legacy) CMS Portal](#legacy-cms-portal).\n\n## General SEO best practices\n\n### Store settings\n\nProperly configuring the elements of your ecommerce store, such as titles, descriptions, media, and URLs, can significantly impact how search engines index and rank your pages.\n\n#### Titles and descriptions\n\nWhen setting up your store, consider how title tags and descriptions affect your store’s SEO:\n\n* **Title tags:** Use primary keywords at the beginning of the title and ensure titles are concise (50-60 characters). The value assigned to this tag is displayed at the top of the browser's title bar when someone visits your website. It can be configured for home, [product](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/product-registration-fields--4dYXWIK3zyS8IceKkQseke), [category](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/category-registration-fields--5Z7RrvW41yumyQCmk2iqoG), and [brand](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/brand-registration-fields--37Ky7lTbEkiWIAYA80EMyI) pages.\n* **Meta descriptions:** Include relevant keywords, limit them to 140-160 characters, and provide a compelling reason for users to click, which will help improve organic traffic. Meta descriptions are crucial for SEO because they appear in search engine results pages (SERPs) as snippets under the page title, giving users an idea of what they can find on the site. They can be configured for home, product, category, and brand pages on the same setup page where you configure the title tags directly in the VTEX Admin.\n* **Unique content:** Avoid duplication across pages. Make sure titles and descriptions are unique for each page to improve search visibility and prevent keyword cannibalization, where multiple pages compete for the same search terms.\n* **Robots.txt:** Edit or customize your `robots.txt`, which is a text file that search engines use to define site scanning rules for crawlers based on your business needs. Learn more in [Google Search Console Tracking - robots.txt](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/google-search-console-tracking-robots-txt--tutorials%5F574).\n\n#### Images and videos\n\nWhen adding images or videos to your store, whether for SKUs, banners, or any other page on your site, follow these guidelines:\n\n* **Media file name:** Rename media files used in your store with descriptive keywords, avoiding generic names such as `image1.png`.\n* **`alt text`:** Use clear `alt text` with relevant keywords to describe the media content accurately. Search engines don't read images and videos, so each media piece should have personalized alternative text (`alt text`). Moreover, the `alt text` promotes [Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility) by helping visually impaired users understand the content on the page.\n* **Image optimization:** Compress images to improve page load speed without sacrificing quality. Learn more in [Image compression](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/image-compression--4klbgpsPksq44KcwqKeye8).\n\n#### URLs\n\nWhen defining the URLs for your site, keep in mind the following best practices:\n\n* **Keyword-friendly URLs:** Incorporate primary keywords into short, clean, and descriptive URLs. Use hyphens to separate words in URLs, enhancing readability and clarity for users and search engines. For product pages, the URL is defined by the `textLink` field in the product settings, as outlined in the guide [Filling in the category registration fields](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/category-registration-fields--5Z7RrvW41yumyQCmk2iqoG).\n* **Canonical tags:** Use canonical tags on your site to indicate the preferred version of a URL when there are multiple pages with similar content. This prevents duplicate content issues by consolidating ranking signals and ensuring search engines index the correct page. On VTEX, the canonical tag is generated automatically for all store pages, such as product, category, brand, and custom.\n\n> In cross-border stores, you must configure the canonical tag for each binding, as they have different canonical base addresses. For example: `store.com/en` and `store.com/pt`. Learn more in [Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1).\n\n### Monitoring and analysis\n\nEffective monitoring and analysis are crucial for understanding the impact of your SEO efforts and making data-driven decisions:\n\n* **Implement schema markup:** Structured data (schema markup) helps search engines better understand the content and enhance rich snippets in search results. Learn more in [Structured data through Google Search Console Data Markers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/structured-data-through-google-search-console-data-markers--tutorials%5F560).\n* **Track keyword rankings:** Use tools such as [Google Search Console](https://read.calvincode.net/reader?url=https://search.google.com/search-console/about) to monitor the rankings of your target keywords over time and identify trends and fluctuations, which will help you understand what is working and where improvements are needed.\n* **Analyze website traffic:** Use [Google Analytics](https://read.calvincode.net/reader?url=https://analytics.google.com/) or your preferred tool to track organic traffic, page views, and user behavior on your site.\n* **Evaluate on-page performance:** Analyze page load times, mobile usability, and overall user experience with tools such as [PageSpeed Insights](https://read.calvincode.net/reader?url=https://pagespeed.web.dev/). Review on-page metrics such as bounce rate, time on page, and conversion rates to assess content effectiveness.\n\nLearn more in [Integration with monitoring tools](https://read.calvincode.net/reader?url=https://help.vtex.com/subcategory/tracking-integration--1luKrYptdi8WoMYckakUaM).\n\n## FastStore\n\nFor stores developed with [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore), follow these specific practices:\n\n* **Configuration and setup:** Configure fundamental SEO settings during the project onboarding and after in the `discovery.config.js` file. Learn more in [SEO guide overview for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview).\n* **Canonical tags:** Ensure canonical tags are correctly implemented on all pages, especially on Product Listing Pages (PLPs) that use URL parameters for functionality. Products accessible via multiple URLs must specify a canonical version to avoid duplicate content.\n* **Structured Data (Schema):** \n * Use global identifiers like GTIN or UPC codes in your product schema. If catalog data is incomplete, you may need to customize the schema client-side. \n * Map the SEO title to the schema `name` field. Use the product name, not the SKU, if no SEO title is set. \n * Ensure the `availability` field accurately reflects stock status using standard [Schema.org](https://read.calvincode.net/reader?url=https://schema.org/) URLs (`InStock`, `OutOfStock`). \n * Enrich data with Manufacturer Part Numbers (MPN) to improve chances for rich results. \n * Remove deprecated Offer schema fields such as `listPriceWithTaxes` and `priceWithTaxes`.\n* **Performance and Crawlability:** \n * **Lazy Loading:** Apply lazy loading strategically. Avoid using it on critical content sections of PLPs and PDPs to ensure search engine bots can crawl all content. Disabling it entirely can make all content immediately available for crawling, but it can also harm overall performance. Learn more in [Optimizing SEO by managing lazy loading on PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp). \n * **Caching:** Use `GET` requests (not `POST`) for custom queries to improve caching, which benefits performance and SEO. Learn more in [Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-configuring-graphql-cache-control). \n * **Page Types:** When building department pages, favor the Product List Page (PLP) template over a Landing Page (LP). PLPs support better caching and automate structured data for breadcrumbs.\n* **Core Web Vitals:** Actively monitor and fix issues with Cumulative Layout Shift (CLS) and Largest Contentful Paint (LCP) using tools like PageSpeed Insights.\n* **404 Tracking:** Implement custom title tags for 404 pages to easily identify and track them in analytics platforms.\n\n## Store Framework\n\nFor stores developed with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework), follow these specific practices:\n\n* **Store SEO settings:** Configure basic SEO settings for the home page through VTEX Admin by accessing **Store Settings > Storefront > Store**. Learn more in [Configuring SEO in your Store Framework store](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/configuring-seo-in-your-store--1sKskEsjUSvgHyqM8oknVR).\n* **Intelligent Search for Categories:** Use the [VTEX Intelligent Search app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8) to customize titles and meta descriptions for Department, Category, and Subcategory pages within the search navigation bar. Learn more in [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search).\n* **Product Listing Pages (PLP):** Implement specific strategies to enhance the SEO of your category pages. Learn more in [Improving the SEO of Product Listing Pages](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/improving-the-seo-of-product-listing-pages--UrQtlKAMuSaLBP5wG9ftG).\n\n## (Legacy) CMS Portal\n\nFor stores using the (Legacy) CMS Portal, configure SEO settings as follows:\n\n* **Home page SEO:** Configure the home page `meta tag description` and `robots.txt` file through **Store Settings > Storefront > Settings** in the VTEX Admin. Learn more in [Settings](https://read.calvincode.net/reader?url=https://help.vtex.com/en/docs/tracks/legacy-cms-portal%23settings).\n* **Meta tags control:** Use the meta tags control feature to improve SEO on other pages (product, category, etc.). Learn more in [How to use the meta tags control](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-use-the-meta-tags-control--2OPiSPubgcEqIikAWsCouk).\n* **Titles and URLs:** Configure title tags and URLs for products, categories, and brands in their respective registration fields in the Admin: \n * [Product registration fields](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/product-registration-fields--4dYXWIK3zyS8IceKkQseke) \n * [Category registration fields](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/category-registration-fields--5Z7RrvW41yumyQCmk2iqoG) \n * [Brand registration fields](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/brand-registration-fields--37Ky7lTbEkiWIAYA80EMyI)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\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/storefront-seo.md)\n\n[Getting started with Lighthouse« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo//docs/guides/storefront-getting-started-with-lighthouse)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[General SEO best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23general-seo-best-practices)\n\n[Store settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23store-settings)[Monitoring and analysis](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23monitoring-and-analysis)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23faststore)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23store-framework)\n\n[(Legacy) CMS Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23legacy-cms-portal)\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-seo.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[General SEO best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23general-seo-best-practices)\n\n[Store settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23store-settings)[Monitoring and analysis](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23monitoring-and-analysis)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23faststore)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23store-framework)\n\n[(Legacy) CMS Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo/docs/guides/storefront-seo%23legacy-cms-portal)\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_c08b74e3
|
[
{
"role": "system",
"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 avoiding cors in master data requests 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/avoiding-cors-in-master-data-requests/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/api-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/avoiding-cors-in-master-data-requests/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/avoiding-cors-in-master-data-requests/docs/storefront-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/avoiding-cors-in-master-data-requests/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/avoiding-cors-in-master-data-requests/docs/troubleshooting)\n\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/avoiding-cors-in-master-data-requests/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/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/avoiding-cors-in-master-data-requests/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/master-data-best-practices)\n\n[Extracting data from Master Data with search and scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/extracting-data-from-master-data-with-search-and-scroll)\n\n[Pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/pagination-in-the-master-data-api)\n\n[Avoiding CORS in Master Data requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/avoiding-cors-in-master-data-requests)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/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/avoiding-cors-in-master-data-requests/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/avoiding-cors-in-master-data-requests/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/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/avoiding-cors-in-master-data-requests/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/master-data-best-practices)\n\n[Extracting data from Master Data with search and scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/extracting-data-from-master-data-with-search-and-scroll)\n\n[Pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/pagination-in-the-master-data-api)\n\n[Avoiding CORS in Master Data requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/avoiding-cors-in-master-data-requests)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/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/avoiding-cors-in-master-data-requests/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/avoiding-cors-in-master-data-requests/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/master-data-best-practices)\n\n[Avoiding CORS in Master Data requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/avoiding-cors-in-master-data-requests)\n\nAvoiding CORS in Master Data requests\n\nLearn how to avoid CORS issues in your Master Data requests.\n\nCross-origin resource sharing (CORS) is not an error but a security mechanism designed to protect users from dangerous Javascript and unwarranted HTTP requests.\n\nCORS is triggered when an HTTP endpoint requests:\n\n* a different domain (e.g., `vtex.com` calls `vtexcommercestable.com`)\n* a different subdomain (e.g., `store.com` calls `blog.store.com`)\n* a different port (e.g., `store.com` calls `store.com:3001`)\n* a different protocol (e.g., a site at `https://store.com` calls `http://store.com`)\n\nYour browser blocks every request that fits into one of the four conditions above. This might cause unexpected site behavior and frustration as some functionality may stop functioning.\n\nFurthermore, whenever the browser has to check if the backend supports CORS, an additional `OPTION` request is sent back to **Master Data**. Improperly configured websites generate a great deal of these avoidable requests.\n\n## Best practices\n\nThis section will cover best practices for using **Master Data** API endpoints. These practices will help you create more efficient and maintainable code.\n\n| ✅ Do | ❌ Don't |\n| ------------------------------------------------ | -------------------------------------------------------------------- |\n| $.getJSON(\"/foobar/dataentities/SL/search?\\_.... | https://account.vtexcommercestable.com.br/api/dataentities/SL/search |\n\nTo perform Master Data entity searches correctly, opt for relative paths, as demonstrated in the jQuery example. This approach simplifies your code by eliminating the need to include account names and environments in each request.\n\nDo not make direct requests to **Master Data** endpoints, and avoid including account names and environments directly in the endpoint.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-best-practices/avoiding-cors-in-master-data-requests.md)\n\n[Pagination in the Master Data API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests//docs/guides/pagination-in-the-master-data-api)[Master Data v2Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests//docs/guides/master-data-v2)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/avoiding-cors-in-master-data-requests%23best-practices)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-best-practices/avoiding-cors-in-master-data-requests.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/avoiding-cors-in-master-data-requests/docs/guides/avoiding-cors-in-master-data-requests%23best-practices)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_7ae8fdc9
|
[
{
"role": "system",
"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 enabling performance settings 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-enabling-performance-settings/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-enabling-performance-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/guides/vtex-io-documentation-enabling-performance-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/guides/vtex-io-documentation-enabling-performance-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/guides/vtex-io-documentation-enabling-performance-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/guides/vtex-io-documentation-enabling-performance-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/guides/vtex-io-documentation-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/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-enabling-performance-settings/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/store-framework)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/store-framework-managing-performance)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\nEnabling performance settings\n\nFor ecommerce businesses, appealing offers, high-quality products, or brand recognition might not be enough to convert leads if the user experience falls short. Store website performance is essential to the user experience, directly impacting sales conversion rate, user session time, and other metrics. Every millisecond counts and affects the consumer decision-making process and website ranking in search engine results.\n\nThis guide outlines actions you can implement to optimize store performance. These [optimization options](#optimization-options) can improve SEO score and page loading time. You can measure these improvements using tools like [Google Lighthouse](https://read.calvincode.net/reader?url=https://developers.google.com/web/tools/lighthouse) and [Google Analytics](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/1205784?hl=en). Learn more in the **Monitoring tools** section in the [Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance) guide.\n\nThis guide is divided into the following sections:\n\n* [Instructions](#instructions): Instructions for enabling and deploying performance optimizations in your store, including workspace setup, Admin configuration, and promoting changes to production.\n* [Optimization options](#optimization-options): Methods to enhance store performance, categorized by: \n * [Store settings](#store-settings): Actions that can be performed directly in the VTEX Admin. \n * [Manual optimizations](#manual-optimizations): Additional manual actions for advanced performance that require direct code changes.\n\n## Instructions\n\n### Step 1 - (Optional) Testing manual optimizations\n\nIf you have implemented [manual optimizations](#manual-optimizations), make sure to use a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) to test them before making your new app version publicly available. Learn more about this process in the guide [Deploying a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available).\n\n### Step 2 - Applying changes in a production workspace\n\n1. Using the terminal and the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/), log in to the desired account by running `vtex login {account}`.\n2. Run the command `vtex use {productionWorkspace} --production` to create and use a **new** [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/). \n> Replace the values between the curly braces based on your scenario.\n3. Using your browser, access the Admin for that workspace.\n4. In the account's Admin, go to **Store Settings > Storefront > Store > Advanced**.\n5. Follow the instructions in the [Store settings](#store-settings) section to activate the desired features, then save the changes.\n6. Access your store in the workspace you're using and check whether the performance improvements were applied.\n\n> Changes may take some time to be reflected.\n\n### Step 3 - Testing and analyzing performance\n\n1. Review and test all main pages, ensuring the changes didn't cause any side effects, such as style inconsistencies or undesired behaviors.\n2. Access [Google PageSpeed Insights](https://read.calvincode.net/reader?url=https://developers.google.com/speed/pagespeed/insights).\n3. Using the following URL pattern: `https://{account}.myvtex.com/?workspace={productionWorkspace}`, check store performance in the production workspace where you're currently working.\n\n> Using the standard URL pattern `https://{workspace}--{account}.myvtex.com/` won't show the store performance score in the specified workspace. To analyze performance in a workspace, **you must use the `?workspace={productionWorkspace}` query string** as shown in Step 3.3.\n\n### Step 4 - Making your changes publicly available\n\nIf you're satisfied with the results, run `vtex promote` to promote your workspace and benefit from a faster store. Before promoting your workspace to master, measure the performance improvements by comparing the performance scores in the production and master workspaces.\n\n## Optimization options\n\n### Store settings\n\nStore settings are actions you can configure directly in the VTEX Admin by navigating to **Store Settings > Storefront > Store > Advanced**.\n\n\n\n#### OrderForm optimization\n\nThis action disables the legacy `orderForm` provider.\n\nThe `orderForm` is an object that stores and retrieves data from user orders, including each item added to the cart. To give other Store Theme blocks access to the data stored in the `orderForm` and allow them to render it, Store Framework runs the `OrderFormProvider` object on each store page. This object exports all the necessary `orderForm` information to these blocks.\n\nHowever, all stores using VTEX IO Store Framework currently have two `OrderFormProviders`: a legacy version, still consumed by native blocks such as `minicart` and `buy-button`, and a newer version, better suited for replacement.\n\nWe recommend that stores using `minicart.v2` and `add-to-cart-button` blocks (instead of `minicart` and `buy-button`, respectively) disable the legacy provider. Consuming a single provider will improve store performance.\n\nLearn more in the guide [Enabling OrderForm optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/).\n\n#### Service worker\n\nThis action adds the default service worker provided by VTEX.\n\nThe VTEX IO platform provides a native service worker to every store using Store Framework. If you need to use a third-party service with its service worker, you may face conflicts. You can deactivate the native VTEX service worker to resolve this.\n\nLearn more in the guide [Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/).\n\n#### Critical CSS optimization\n\nThis action enables CSS optimizations on your pages to boost performance and improve Lighthouse scores. It lets the browser identify and load essential CSS needed for critical, above-the-fold content first, while loading the remaining CSS code asynchronously.\n\n\n\nHowever, by default, the browser initiates the rendering of a web page after it finishes loading, parsing, and executing all related CSS files. Consequently, the more extensive the CSS code, the longer it takes to render the critical part of the page.\n\nThis optimization can be enabled for the following pages:\n\n* Homepage\n* Search page\n* Custom pages\n* Product page\n\n> Enabling these options might cause style inconsistencies in the store layout. Test these changes carefully before enabling them on a production workspace. If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Enable CSS concatenation\n\nThis action concatenates a page's CSS in a single file for faster download, reducing the HTTP requests required to load each CSS file separately.\n\n\n\n#### Enable prefetch\n\nThis action prefetches pages when a user hovers over a link.\n\nWhen enabled, the page content is proactively downloaded in the background when you hover over a link. This means that the page is already loaded or partially loaded when you click the link.\n\n#### Enable lazy runtime\n\nThis action enables lazy loading of page metadata.\n\nBefore displaying a web page, the VTEX IO service app that renders server-side (Render Runtime) interprets the page metadata script. See the example below:\n\n`1\n\n<script> \n\n2\n\n __RUNTIME__ = {\"account\":\"vtexstore\",\"amp\":false,\"bindingChanged\":false,\"binding\":{\"id\":\"aacb04t3-a8fa-4bab-b5bd-2d654d20dcd8\",\"canonicalBaseAddress\":\"vtexstore.vtex.com\"},\"culture\":{\"availableLocales\":[],\"country\":\"USA\",\"currency\":\"USD\",\"language\":\"en\",\"locale\":\"en-US\",\"customCurrencyDecimalDigits\":null,\"customCurrencySymbol\":\"$\"},\"production\":true,\"query\":{},\"settings\":{.... \n\n`\n\nThis script contains significant web page data and can be long, demanding significant browser processing. When you enable lazy runtime, the script is broken into smaller scripts to avoid compromising the total blocking time of the store website. This helps avoid lengthy tasks, leading to a faster store experience.\n\n> Some apps might not work as expected when this option is enabled. Test with caution before enabling it on a production workspace. If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Enable lazy rendering of submenu items\n\nBy enabling this action, menus containing submenus automatically apply the `experimentalOptimizeRendering` prop. This configuration prevents the entire set of `submenus` from loading unnecessarily, as `submenus` only load when the user interacts with the parent menu where the prop is set.\n\n> Google won't be able to track the hidden submenu items for SEO, as their content only loads with user interaction. Make sure your SEO strategy is covered by the store sitemap or the first meaningfully painted content.\n\n#### Enable lazy rendering of search results and facets\n\nThis action enables lazy rendering for the scrollable facet box and search results pages. Content within the user's viewport loads first, and content outside the viewport loads only as the user scrolls.\n\n> Enabling this option might cause unexpected behaviors, such as gaps while scrolling. If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Enable loading scripts asynchronously\n\nThis action allows the browser to load and execute scripts asynchronously. This means the browser doesn't wait for the script to fully download and execute before continuing to parse and render the rest of the page. Instead, it can process other elements of the page concurrently while the script loads in the background.\n\n#### Enable concurrent React mode\n\nThis action helps the store stay responsive by adjusting to the capabilities of the user's device and network speed. This means rendering tasks can be prioritized and interrupted based on user interactions or current network conditions.\n\nFor example, if a user begins typing in a search bar while other content is still loading, concurrent mode can pause loading to process your input, ensuring the search bar remains responsive. Once the input is handled, rendering can resume without perceived delays.\n\n#### Enable fetching filters partially\n\nWhen you enable this action, search results pages display a maximum of 10 facets per filter.\n\nThe search query won't automatically retrieve any additional facets or show them to the user. Instead, a `Show more` button allows users to load the remaining facets.\n\n> A facet is a filter value. For example, `Color` is a filter, and `Blue` is a facet of that filter.\n\n#### Enable executing all GraphQL queries on the product page\n\nThis action allows the product page to fetch additional data necessary to render components positioned above-the-fold. This helps ensure that product details, images, and any other components in the main view display together without delays or missing information.\n\n> Enable this only if your product page truly needs it; otherwise, it may lead to deoptimization.\n\n#### Enable lazy rendering of the page footer\n\nThis action renders the page footer and loads its assets lazily, which helps improve performance when first rendering the page.\n\n#### Enable lazy loading of assets below the fold\n\nThis action enables lazy loading of the JavaScript files of the components below the `_fold_` block. This keeps the initial load fast and reduces unnecessary bandwidth usage for users who never scroll.\n\n#### Enable page number in meta title\n\nThis option adds a `#{Number}` to the HTML title. This helps both users and search engines know exactly which page they're viewing and avoids duplicate titles, which can impact SEO.\n\n> It's best suited for stores using traditional pagination. After enabling, review your page titles to make sure they remain clear and consistent.\n\n#### Canonical URL without URL parameters\n\nThis action removes the map parameter from the canonical URL, so search engines focus on a single, clean address for each page.\n\n> This may cause issues when visiting a page with selected facets. Test with caution after turning it on.\n\n#### Remove store name from title\n\nThis action removes the store name from the end of page titles on product and category pages, resulting in shorter titles that may highlight product keywords better for SEO.\n\n#### Enable custom currency symbol\n\nThis action uses the `Currency Symbol` field defined in the trade policy. This ensures that prices are displayed in the format and symbol your customers expect, which is especially important for international or multi-currency stores.\n\n#### \\[BETA\\] Show sponsored products on search results\n\nThis action enables stores in the Retail Media Network (RMN) pilot to place advertiser-sponsored products alongside organic search results.\n\n> This action is available only for stores that have joined the RMN pilot. For more information, email **[rmn@vtex.com](mailto:rmn@vtex.com)**.\n\n#### Enable default browser navigation\n\nEnabling this action means each store page loads separately with full reloads instead of rendering through the VTEX IO service app on the server (Render Runtime). This default browser navigation can be useful for troubleshooting or when experiencing issues with client-side routing.\n\n> Full-page reloads are generally slower and consume more bandwidth than the standard VTEX navigation. Use this only when necessary for testing or for compatibility, and consider whether the change impacts user experience or conversion rates.\n\n### Manual optimizations\n\nIn addition to the features configured in the VTEX Admin, you can apply manual optimizations directly in the project source code to enhance store performance.\n\n#### Improving scrolling performance\n\nUse the `__fold__` block for scrollable pages. This allows you to specify which interface components load initially (above the fold) and which are lazy-loaded as the user scrolls.\n\nYou can also use the `__fold__.experimentalLazyAssets` block to define which theme blocks should load statically upon the first user interaction.\n\nLearn more about fold blocks in the guide [Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks).\n\n> If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Reducing the number of menu blocks\n\nIf a menu block doesn't have a submenu, configure it to use `menu-item` blocks as props instead of children.\n\nIn the example below, the main `menu items` (Apparel & Accessories, Home & Decor, and More) can't be modified in their implementation. They must remain as children since they have a trigger to open a `submenu`.\n\n\n\nHowever, the internal `menu-items` (Clothing, Accessories, and Eyeglasses) can be changed from children to props.\n\nPreviously, each `menu-item` was set up as an individual child/block. With the change, the `menu-items` group, declared as props, is treated as a single block, represented by a blue square.\n\nThis approach reduces the number of blocks from 3 to 1, improving store performance.\n\nLearn more about applying both configurations in the [Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu) guide.\n\n#### Adjusting image sizes\n\nThe size of images in your store directly impacts performance. To optimize image rendering, follow the practices outlined in the guide [Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/), focusing on the media types used in your theme.\n\n#### Improving search results\n\nTo avoid performance issues on search results pages, use the `skusFilter` and `simulationBehavior` props. These props control the SKUs returned for each product in the search query, determining whether the displayed search data will be current (`skusFilter`) or retrieved from the cache (`simulationBehavior`).\n\nWe recommend setting `skusFilter` to `FIRST_AVAILABLE` to return only the first available SKU for each product, and `simulationBehavior` to `skip` to display search data from the cache.\n\nLearn more about prop configuration in the [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) app documentation.\n\n#### Using lazy loading for sliders\n\nBuild the shelf and carousel blocks of your theme using the [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout) component.\n\nSlider Layout uses lazy loading to automatically load images and product information only when users interact with shelves or carousels, reducing page load time. However, having more products in these components may negatively impact website performance.\n\nLearn more about using Slider Layout in the guides [Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/) and [Building a Carousel using Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout/).\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/boosting-performance/vtex-io-documentation-enabling-performance-settings.md)\n\n[Getting started with Lighthouse performance audit« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings//docs/guides/vtex-io-documentation-getting-started-with-lighthouse)[Tracking changes in Lighthouse performance scoreNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings//docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\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-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23instructions)\n\n[Step 1 - (Optional) Testing manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-1-optional-testing-manual-optimizations)[Step 2 - Applying changes in a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-2-applying-changes-in-a-production-workspace)[Step 3 - Testing and analyzing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-3-testing-and-analyzing-performance)[Step 4 - Making your changes publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-4-making-your-changes-publicly-available)\n\n[Optimization options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23optimization-options)\n\n[Store settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23store-settings)[Manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23manual-optimizations)\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/boosting-performance/vtex-io-documentation-enabling-performance-settings.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-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23instructions)\n\n[Step 1 - (Optional) Testing manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-1-optional-testing-manual-optimizations)[Step 2 - Applying changes in a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-2-applying-changes-in-a-production-workspace)[Step 3 - Testing and analyzing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-3-testing-and-analyzing-performance)[Step 4 - Making your changes publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-4-making-your-changes-publicly-available)\n\n[Optimization options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23optimization-options)\n\n[Store settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23store-settings)[Manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23manual-optimizations)\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_d6bb60ce
|
[
{
"role": "system",
"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 interface 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-interface/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-interface/docs/api-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-interface/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-interface/docs/storefront-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-interface/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-interface/docs/troubleshooting)\n\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-interface/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-interface/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-interface/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/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-interface/docs/guides/getting-started-3)\n\nConcepts\n\n[Composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-composition)\n\n[Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-interface)\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-properties)\n\n[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-slots)\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/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-interface/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-interface/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-interface/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-interface/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-interface/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-interface/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-interface/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-interface/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-interface/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/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-interface/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-interface/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-interface/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-interface/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-interface/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/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-interface/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-interface/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/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-interface/docs/guides/getting-started-3)\n\nConcepts\n\n[Composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-composition)\n\n[Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-interface)\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-properties)\n\n[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-slots)\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/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-interface/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-interface/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-interface/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-interface/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-interface/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-interface/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-interface/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-interface/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-interface/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/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-interface/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-interface/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-interface/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-interface/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-interface/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/store-framework)\n\nConcepts\n\n[Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-interface)\n\nInterfaces\n\nInterfaces establish a relation between a block and a React component, allowing the [store builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder) to build the store frontend. These interfaces are defined in the app's `interfaces.json` file.\n\nInterfaces provide a set of rules that dictate the behavior of theme blocks when rendering their React components and the available properties and methods.\n\nFor each theme block exported by your app, you should define a corresponding interface that defines the props available to the React component.\n\nThe following table shows some possible keys that could be added to the block interface, as well as their respective descriptions:\n\n| Key | Description |\n| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| component | Name of the React component that the theme block will render. |\n| allowed | List of other theme blocks that help build the desired React component. When declared, these blocks can be included as children to the block you developed in the Store Theme app. |\n| composition | Defines the rendering position of the children of the block that you are developing. Remember that when defining the composition key, you don't control the position of the block it defines but the position of the children of that block. Possible values for this key are blocks (the child blocks have a specific position in the interface based on the React component on which they are based) or children (the position of the child blocks depends exclusively on how they are declared in the theme). If no value is defined for the composition key, the platform default is blocks. |\n| device | Defines whether your theme block is designed for mobile or desktop devices. Possible values are mobile and desktop. |\n| required | List of theme blocks that must be rendered in the interface to support the block rendering you are developing. |\n| around | List of theme blocks that must be rendered in the interface around your new block for it to work correctly. |\n| before | List of theme blocks that must be rendered in the interface before your block (above it) for it to work correctly. For example: header. |\n| after | List of theme blocks that must be rendered in the interface after your block (below it) for it to work correctly. For example: footer. |\n| preview | Defines the behavior of the page while the block is loading. |\n| render | Defines the block rendering type. Possible values are lazy (the block is only rendered when a user interacts with it), server (the block is rendered from the server side), or client (the block is rendered from the client side. |\n\nThe only required key that needs to be declared in a block interface is `component`. You may declare the other ones based on the desired scenario for your new theme block.\n\n## Example\n\nFor each exported block, the app specifies a corresponding React component. For example:\n\n`1\n\n// product-summary/store/interfaces.json \n\n2\n\n{ \n\n3\n\n \"product-summary\": { \n\n4\n\n \"component\": \"ProductSummary\", \n\n5\n\n \"composition\": \"children\", \n\n6\n\n \"content\": { \n\n7\n\n \"$ref\": \"app:vtex.product-summary#/definitions/ProductSummary\" \n\n8\n\n } \n\n9\n\n } \n\n10\n\n} \n\n`\n\nLet's delve into this example of a component named `ProductSummary`:\n\n* `product-summary`: Sets the name of the interface block being defined.\n* `component`: Specifies the name of the React component (`ProductSummary`) associated with the interface. Check [Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components) for more information.\n* `composition`: Indicates the structure and composition of the component within its parent component. Check [Composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition) for more information.\n* `content`: Points to an external schema definition for the `ProductSummary` component. The structure and properties expected within the `ProductSummary` component are defined in a separate schema file associated with the `vtex.product-summary` app.\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/Reference/concepts/vtex-io-documentation-interface.md)\n\n[Composition« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface//docs/guides/vtex-io-documentation-composition)[PropertiesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface//docs/guides/vtex-io-documentation-properties)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-interface%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/vtex-io/Reference/concepts/vtex-io-documentation-interface.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface/docs/guides/vtex-io-documentation-interface%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_51f9492d
|
[
{
"role": "system",
"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 minicart 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-minicart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/api-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-minicart/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-minicart/docs/storefront-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-minicart/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-minicart/docs/troubleshooting)\n\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-minicart/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/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-minicart/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/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-minicart/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-minicart/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/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-minicart/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-minicart/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/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-minicart/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/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-minicart/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-minicart/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/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-minicart/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-minicart/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-minicart/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/guides/basic-components)\n\nMinicart\n\nOfficial extension\n\nVersion: 2.68.0\n\nLatest version: 2.68.0\n\n[](#contributors-)\n\n> Minicart v1 block has been deprecated in favor of Minicart v2, which can be customized using the blocks defined by [Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list) and [Checkout Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary). If you still use Minicart v1, see the [Minicart v1 documentation](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart/blob/383d7bbd3295f06d1b5854a0add561a872e1515c/docs/README.md).\n\nThe Minicart is a block that displays a summary list of all items added to the shopping cart, fetched from the Checkout OrderForm API.\n\n\n\n## Configurating Minicart\n\n1. Import the Minicart app to your theme dependencies in the `manifest.json`, as shown below:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.minicart\": \"2.x\" \n\n3\n\n} \n\n`\n\n1. Add the `minicart.v2` block to your `header`. For example:\n\n`1\n\n\"header.full\": { \n\n2\n\n \"blocks\": [\"header-layout.desktop\", \"header-layout.mobile\"] \n\n3\n\n }, \n\n4\n\n \n5\n\n \"header-layout.desktop\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"header-row#1-desktop\", \n\n8\n\n ] \n\n9\n\n }, \n\n10\n\n \n11\n\n \"header-row#1-desktop\": { \n\n12\n\n \"children\": [\"minicart.v2\"], \n\n13\n\n }, \n\n`\n\n> Minicart v2 will only effectively function if the store uses the [add-to-cart app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button) instead of the [buy-button block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton) in blocks such as the Shelf and the Product Details page. This is because Minicart v2 was built based on an indirect dependency on the Add to Cart button. This means that even if Minicart v2 is correctly configured in the code, it cannot be rendered by other shopping buttons, such as the Buy button.\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |\n| variation | enum | Minicart behavior when rendered. Possible values for displaying the VTEX Minicart are: popup (appears as a pop-up window on the homepage), drawer (appears as a sidebar), link (redirects the user to the Checkout page when clicked), popupWithLink (combines link and popup functionalities), and block (displays the Minicart as a fixed block on the page). | drawer |\n| drawerSlideDirection | enum | Slide direction for the drawer Minicart opening. Possible values are: rightToLeft or leftToRight. | rightToLeft |\n| linkVariationUrl | string | Link associated with the link Minicart. | undefined |\n| maxDrawerWidth | number | Maximum width (in pixels) for the drawer Minicart when opened. | 440 |\n| openOnHover | boolean | Indicates whether the popup Minicart should open when the user hovers over it. | false |\n| quantityDisplay | enum | Shows the quantity badge even when the amount of products in the cart is zero. Possible values are: always or not-empty or never. | not-empty |\n| itemCountMode | enum | Quantity badge behavior when displaying the total items added to Minicart. Possible values are: total (quantity badge displays the number of items added to the cart), distinct (only displays the number of different products added to the cart), totalAvailable (displays the number of available items added to the cart), and distinctAvailable (displays the number of different _and_ available products added to the cart). | distinct |\n| backdropMode | enum | Controls whether the backdrop should be displayed when the drawer Minicart is opened or not. Possible values are: visible (renders the backdrop) or none (renders the drawer without backdrop). | none |\n| MinicartIcon | block | Icon displayed on the Minicart button. This prop value must match the block name responsible for rendering the desired icon. | icon-cart (from the [Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/) app) |\n| customPixelEventId | string | Store event ID responsible for triggering the minicart.v2 to automatically open on the interface. | undefined |\n| customPixelEventName | string | Store event name responsible for triggering the minicart.v2 to automatically open on the interface. Some examples are: 'addToCart' and 'removeFromCart'. Note that using this prop will make the minicart.v2 open in **every** event with the specified name if no customPixelEventId is specified. | undefined |\n| classes | CustomCSSClasses | Used to override default CSS handles. To better understand how this prop works, we recommend reading about it [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only useful when importing this block as a React component. | undefined |\n\n### Advanced configurations\n\nThe default implementation for `minicart.v2` can be highly customizable by using other blocks. Currently, its default implementation is as follows:\n\n`1\n\n// This is the default block implementation for the minicart-layout \n\n2\n\n{ \n\n3\n\n \"minicart.v2\": { \n\n4\n\n \"props\": { \n\n5\n\n \"MinicartIcon\": \"icon-cart#minicart-icon\" \n\n6\n\n }, \n\n7\n\n \"children\": [\"minicart-base-content\"] \n\n8\n\n }, \n\n9\n\n \"icon-cart#minicart-icon\": { \n\n10\n\n \"props\": { \n\n11\n\n \"size\": 24 \n\n12\n\n } \n\n13\n\n }, \n\n14\n\n \"minicart-base-content\": { \n\n15\n\n \"blocks\": [\"minicart-empty-state\"], \n\n16\n\n \"children\": [\"minicart-product-list\", \"flex-layout.row#minicart-footer\"] \n\n17\n\n }, \n\n18\n\n \"flex-layout.row#minicart-footer\": { \n\n19\n\n \"props\": { \n\n20\n\n \"blockClass\": \"minicart-footer\" \n\n21\n\n }, \n\n22\n\n \"children\": [\"flex-layout.col#minicart-footer\"] \n\n23\n\n }, \n\n24\n\n \"flex-layout.col#minicart-footer\": { \n\n25\n\n \"children\": [\"minicart-summary\", \"minicart-checkout-button\"] \n\n26\n\n }, \n\n27\n\n \"minicart-product-list\": { \n\n28\n\n \"blocks\": [\"product-list#minicart\"] \n\n29\n\n }, \n\n30\n\n \"product-list#minicart\": { \n\n31\n\n \"blocks\": [\"product-list-content-mobile\"] \n\n32\n\n }, \n\n33\n\n \"minicart-summary\": { \n\n34\n\n \"blocks\": [\"checkout-summary.compact#minicart\"] \n\n35\n\n }, \n\n36\n\n \"minicart-checkout-button\": { \n\n37\n\n \"props\": { \n\n38\n\n \"finishShoppingButtonLink\": \"/checkout/#/orderform\" \n\n39\n\n } \n\n40\n\n }, \n\n41\n\n \n42\n\n \"checkout-summary.compact#minicart\": { \n\n43\n\n \"children\": [\"summary-totalizers#minicart\"], \n\n44\n\n \"props\": { \n\n45\n\n \"totalizersToShow\": [\"Items\", \"Discounts\"] \n\n46\n\n } \n\n47\n\n }, \n\n48\n\n \"summary-totalizers#minicart\": { \n\n49\n\n \"props\": { \n\n50\n\n \"showTotal\": true, \n\n51\n\n \"showDeliveryTotal\": false \n\n52\n\n } \n\n53\n\n }, \n\n54\n\n \"minicart-empty-state\": { \n\n55\n\n \"children\": [\"flex-layout.row#empty-state\"] \n\n56\n\n }, \n\n57\n\n \"flex-layout.row#empty-state\": { \n\n58\n\n \"children\": [\"flex-layout.col#empty-state\"] \n\n59\n\n }, \n\n60\n\n \"flex-layout.col#empty-state\": { \n\n61\n\n \"children\": [ \n\n62\n\n \"icon-cart#minicart-empty-state\", \n\n63\n\n \"rich-text#minicart-default-empty-state\" \n\n64\n\n ], \n\n65\n\n \"props\": { \n\n66\n\n \"horizontalAlign\": \"center\", \n\n67\n\n \"verticalAlign\": \"middle\", \n\n68\n\n \"rowGap\": 5 \n\n69\n\n } \n\n70\n\n }, \n\n71\n\n \"icon-cart#minicart-empty-state\": { \n\n72\n\n \"props\": { \n\n73\n\n \"size\": 64, \n\n74\n\n \"blockClass\": \"minicart-empty-state\" \n\n75\n\n } \n\n76\n\n }, \n\n77\n\n \"rich-text#minicart-default-empty-state\": { \n\n78\n\n \"props\": { \n\n79\n\n \"text\": \"Your cart is empty.\" \n\n80\n\n } \n\n81\n\n } \n\n82\n\n} \n\n`\n\nThe default implementation of `minicart.v2` consists of the `JSON` code shown above, which is used behind the scenes whenever you use this block in your store.\n\nTo customize the Minicart configuration, you can copy the code and modify it to your needs.\n\nFor detailed instructions on how to configure each of the blocks that make up `minicart.v2`, read the [Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list) and [Checkout Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary) documentations.\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| arrowUp |\n| minicartCheckoutButton |\n| minicartContainer |\n| minicartContentContainer |\n| minicartFooter |\n| minicartIconContainer |\n| minicartProductListContainer |\n| minicartQuantityBadge |\n| minicartSideBarContentWrapper |\n| minicartTitle |\n| minicartWrapperContainer |\n| popupChildrenContainer |\n| popupContentContainer |\n| popupWrapper |\n\n[Menu« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.menu)[Order PlacedNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.order-placed)\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[Configurating Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.minicart%23configurating-minicart)\n\n[Advanced configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.minicart%23advanced-configurations)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/docs/apps/vtex.minicart%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_b678310a
|
[
{
"role": "system",
"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 product information in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/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-product-information/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-product-information/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-product-information/docs/guides/synchronizing-product-information)\n\n[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/synchronizing-inventory-information)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/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-product-information/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/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-product-information/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-product-information/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-product-information/docs/guides/synchronizing-product-information)\n\n[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/synchronizing-inventory-information)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/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-product-information/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides)\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/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-product-information/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-product-information/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-product-information/docs/guides/synchronizing-product-information)\n\nSynchronizing product information\n\nSync product details such as name, image, price, and category.\n\nTo send catalog information, it is necessary to provide the basic information of a product. The fields may be mandatory or optional in this operation.\n\nLearn more about each field on `POST` [Synchronize product information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/product/bulk/products).\n\n# Product Insertion and Update in the Catalog\n\nTo update the basic product data, the following endpoint must be used:\n\n> 🚧 Batch Insert / Update\n> \n> For each batch insert/update, a maximum of 500 objects per request and 3 simultaneous requests are allowed.\n> \n> Therefore, for an initial load with the entire product base, this limit must be taken into account when sending data.\n\n### Request\n\nProcessing will be performed asynchronously.\n\n`1\n\nPOST https://api-retail-media.newtail.com.br/product/bulk/products HTTP/1.1 \n\n2\n\naccept: application/json \n\n3\n\ncontent-type: application/json \n\n4\n\nx-app-id: <PUBLISHER_APP_ID> \n\n5\n\nx-api-key: <API_KEY> \n\n6\n\n \n7\n\n[ \n\n8\n\n { \n\n9\n\n \"product_sku\": \"sample-120210\", \n\n10\n\n \"name\": \"TechBrand Laptop Model X-15 4GB 256GB SSD 15.6\\\" Display Windows 11 - Gray\", \n\n11\n\n \"url\": \"https://www.example.com/product/4100903080\", \n\n12\n\n \"image_url\": \"https://images.example.com/products/01/00/img/4100903/1/4100903143_1GG.jpg\", \n\n13\n\n \"categories\": [\"Computers\", \"Laptops\"], \n\n14\n\n \"brand\": \"TechBrand\", \n\n15\n\n \"gtins\": [\"7898915633481\"], \n\n16\n\n \"metadata\": { \n\n17\n\n \"key\": \"value1\" \n\n18\n\n } \n\n19\n\n }, \n\n20\n\n { \n\n21\n\n \"product_sku\": \"sample-120211\", \n\n22\n\n \"name\": \"TechBrand Laptop Model X-15 4GB 256GB SSD 15.6\\\" Display Windows 11 - Gray\", \n\n23\n\n \"url\": \"https://www.example.com/product/4100903080\", \n\n24\n\n \"categories\": [\"Computers\", \"Laptops\"], \n\n25\n\n \"brand\": \"TechBrand\", \n\n26\n\n \"gtins\": [\"7898915633481\"], \n\n27\n\n \"tags\": [\"Mega Maio\"] \n\n28\n\n } \n\n29\n\n] \n\n`\n\n### Response\n\n> A successful response will have HTTP code 202.\n\n`1\n\n{ \n\n2\n\n \"messages\": [ \n\n3\n\n \"products will be processed soon\" \n\n4\n\n ] \n\n5\n\n} \n\n`\n\n### Response with Validation Error\n\nFor validations, we use the format defined by [RFC 8927](https://read.calvincode.net/reader?url=https://datatracker.ietf.org/doc/rfc8927/), as exemplified below.\n\n> A failed response will have HTTP code 422.\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"instancePath\": \"/0\", \n\n4\n\n \"schemaPath\": \"#/items/required\", \n\n5\n\n \"keyword\": \"required\", \n\n6\n\n \"params\": { \"missingProperty\": \"product_sku\" }, \n\n7\n\n \"message\": \"must have required property 'product_sku'\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"instancePath\": \"/0\", \n\n11\n\n \"schemaPath\": \"#/items/required\", \n\n12\n\n \"keyword\": \"required\", \n\n13\n\n \"params\": { \"missingProperty\": \"url\" }, \n\n14\n\n \"message\": \"must have required property 'url'\" \n\n15\n\n }, \n\n16\n\n { \n\n17\n\n \"instancePath\": \"/0\", \n\n18\n\n \"schemaPath\": \"#/items/required\", \n\n19\n\n \"keyword\": \"required\", \n\n20\n\n \"params\": { \"missingProperty\": \"image_url\" }, \n\n21\n\n \"message\": \"must have required property 'image_url'\" \n\n22\n\n }, \n\n23\n\n { \n\n24\n\n \"instancePath\": \"/1\", \n\n25\n\n \"schemaPath\": \"#/items/required\", \n\n26\n\n \"keyword\": \"required\", \n\n27\n\n \"params\": { \"missingProperty\": \"name\" }, \n\n28\n\n \"message\": \"must have required property 'name'\" \n\n29\n\n }, \n\n30\n\n { \n\n31\n\n \"instancePath\": \"/1\", \n\n32\n\n \"schemaPath\": \"#/items/required\", \n\n33\n\n \"keyword\": \"required\", \n\n34\n\n \"params\": { \"missingProperty\": \"url\" }, \n\n35\n\n \"message\": \"must have required property 'url'\" \n\n36\n\n }, \n\n37\n\n { \n\n38\n\n \"instancePath\": \"/1\", \n\n39\n\n \"schemaPath\": \"#/items/required\", \n\n40\n\n \"keyword\": \"required\", \n\n41\n\n \"params\": { \"missingProperty\": \"image_url\" }, \n\n42\n\n \"message\": \"must have required property 'image_url'\" \n\n43\n\n } \n\n44\n\n] \n\n`\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/synchronizing-the-catalog-with-vtex-ads/synchronizing-product-information.md)\n\n[Synchronizing the catalog with VTEX Ads« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information//docs/guides/synchronizing-the-catalog-with-vtex-ads)[Synchronizing inventory informationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information//docs/guides/synchronizing-inventory-information)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Product Insertion and Update in the Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/synchronizing-product-information%23product-insertion-and-update-in-the-catalog)\n\n[Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/synchronizing-product-information%23request)[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/synchronizing-product-information%23response)[Response with Validation Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/synchronizing-product-information%23response-with-validation-error)\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/synchronizing-product-information.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Product Insertion and Update in the Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/synchronizing-product-information%23product-insertion-and-update-in-the-catalog)\n\n[Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/synchronizing-product-information%23request)[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/synchronizing-product-information%23response)[Response with Validation Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information/docs/guides/synchronizing-product-information%23response-with-validation-error)\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_b68ef3b9
|
[
{
"role": "system",
"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 hide cancellation buttons 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/hide-cancellation-buttons/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/api-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/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/storefront-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/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/troubleshooting)\n\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/hide-cancellation-buttons/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/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/hide-cancellation-buttons/docs/guides/how-to-customize-vtex-sales-app)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/guides/hide-cancellation-buttons)\n\nHide cancellation buttons\n\nBy default, inStore shows the options to `Cancel total order` and `Cancel order` in the [Order placed page](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/instore-using-the-app--4BYzQIwyOHvnmnCYQgLzdr/TrTtmCGVLTaCSmowGFYDI). If you want to hide these buttons, you can change the display of cancellation options by editing the `checkout-instore-custom.css` file. Check out the [How to customize inStore guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/how-to-customize-instore%23css-customizations) for further information on how to access this file.\n\n## Edit the checkout-instore-custom.css file\n\nTo customize which cancellation options inStore will display, you must declare the following IDs and properties in the `checkout-instore-custom.css` file.\n\nIn the **UI display** column below, you can see where the elements you can hide are rendered in the inStore UI. You can click on each image to enlarge it.\n\n| CSS ID selector name | Description | UI display |\n| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| cancel-total-order | The ID selector you can use to style the Cancel full order button. This button enables total cancellation of orders. |  |\n| cancel-order | The ID selector you can use to style the Cancel order of this package button. This button enables partial cancellation of orders, which means you can cancel individual packages. |  |\n\nIf you want to hide one or both of these elements, you must use their respective ID selector and declare the `display` property with the value set as `none`, as exemplified below.\n\n`1\n\n#cancel-total-order { \n\n2\n\n display: none; \n\n3\n\n} \n\n4\n\n \n5\n\n#cancel-order { \n\n6\n\n display: none; \n\n7\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/how-to-customize-vtex-sales-app/hide-cancellation-buttons.md)\n\n[Enable partial cancellation for Debit or Credit Direct sales« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons//docs/guides/enable-partial-cancellation)[Allow manual prices on VTEX Sales AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons//docs/guides/allow-manual-prices-on-vtex-sales-app)\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[Edit the checkout-instore-custom.css file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/guides/hide-cancellation-buttons%23edit-the-checkout-instore-customcss-file)\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/hide-cancellation-buttons.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Edit the checkout-instore-custom.css file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons/docs/guides/hide-cancellation-buttons%23edit-the-checkout-instore-customcss-file)\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_ae39e137
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore schema mutations in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/faststore-api-overview)\n\nMutations\n\n## Cart\n\n| Field | Argument | Type | Description |\n| ---------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **validateCart** | [StoreCart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecart) | Checks for changes between the cart presented in the UI and the cart stored in the ecommerce platform. If changes are detected, it returns the cart stored on the platform. Otherwise, it returns null. | |\n| cart | [IStoreCart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istorecart)! | Shopping cart input. | |\n| session | [IStoreSession](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoresession) | Web session identifier. | |\n\n> There is a Known Issue with the `validateCart` mutation. If an external request modifies the store cart with additional information like marketing data, it disrupts the store cart synchronization process, interfering with the connection between the cart displayed on the storefront and the actual cart data stored on the server. This may lead to issues for store users, such as items not being added, incorrect totals, or checkout problems. After any external cart update, refresh the cart data using the workaround instructions in the [Cart does not update in FastStore if an external request is made to update orderForm](https://read.calvincode.net/reader?url=https://help.vtex.com/en/known-issues/cart-does-not-update-in-faststore-if-external-request-is-made-to-update-orderform--7ef1GxxapbH2XKKf7HBuAM) guide.\n\n## Session\n\n| Field | Argument | Type | Description |\n| ------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------- |\n| **validateSession** | [StoreSession](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storesession) | Updates a web session with the specified values. | |\n| session | [IStoreSession](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoresession)! | Web session identifier. | |\n| search | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | | |\n| **subscribeToNewsletter** | [PersonNewsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23personnewsletter) | Subscribes a new person to the newsletter list. | |\n| data | [IPersonNewsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23ipersonnewsletter)! | Person data input to the newsletter. | |\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/faststore-api/schema/mutations.mdx)\n\n[Queries« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-queries)[ObjectsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-objects)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations%23cart)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations%23session)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/faststore-api/schema/mutations.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations%23cart)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations%23session)\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_796a2d0a
|
[
{
"role": "system",
"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 comparison 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-comparison/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-comparison/docs/api-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-comparison/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-comparison/docs/storefront-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-comparison/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-comparison/docs/troubleshooting)\n\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-comparison/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-comparison/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/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-comparison/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/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-comparison/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-comparison/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-comparison/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-comparison/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/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-comparison/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-comparison/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/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-comparison/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/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-comparison/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-comparison/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-comparison/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-comparison/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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-comparison/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-comparison/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-comparison/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/advanced-components)\n\nProduct Comparison\n\nOfficial extension\n\nVersion: 0.20.0\n\nLatest version: 0.20.0\n\n[](#contributors-)\n\nThe Product Comparison app compares specifications of pre-selected SKUs, allowing customers to better understand their needs when shopping.\n\nThe app exports several blocks, which you can leverage to display a Product Comparison drawer on your store's search results page and a new Product Comparison page.\n\n\n\n_Product Comparison drawer on the store's search results page_\n\n\n\n_Product Comparison page_\n\n## Configuration\n\n### Step 1 - Adding the Product Comparison app to your theme's dependencies\n\nIn your theme's `manifest.json` file, add the `Product Comparison` app as a dependency:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.product-comparison\": \"0.x\" \n\n3\n\n } \n\n`\n\nNow, you can use all the blocks exported by the Product Comparison app. Check out the full list below:\n\n| Block name | Description |\n| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| product-comparison-drawer |  Main block that renders the drawer from the Product Comparison component in which the items will be compared. |\n| list-context.comparison-product-summary-slider | Extends the list-context block to build the Product Comparison component using the [Slider Layout](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/layout-blocks/vtex.slider-layout/.) |\n| product-summary.shelf.product-comparison | Extends the default product-summary.shelf block (from the [Product Summary app](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/all/vtex.product-summary/)) for the Product Comparison component's features. |\n| product-comparison-block | Logical block that, once extended (see blocks listed below), renders the Product Comparison component's features. |\n| product-comparison-block.selector | Renders the selector checkbox on the Product Comparison component. |\n| product-comparison-block.close-button | Renders the close button on the Product Comparison component. |\n| product-comparison-block.product-summary-row | Renders the first row to list and compare products on the Product Comparison component. |\n| list-context.comparison-row | Extends the list-context block to build a row in the Product Comparison page using the [Slider Layout](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/layout-blocks/vtex.slider-layout/.) |\n| product-comparison-block.grouped-product-specifications | Renders the section for product specification groups. |\n| product-comparison-block.product-specifications | Renders the section for product specifications. |\n| product-comparison-block.sku-specifications | Renders the section for SKU specifications. |\n\n### Step 2 - Adding extended interfaces\n\nIn the theme's `interfaces.json` file, add the following extended interfaces:\n\n`1\n\n+{ \n\n2\n\n+ \"store.search.product-comparison\": { \n\n3\n\n+ \"around\": [\"comparison-context-wrapper\"] \n\n4\n\n+ }, \n\n5\n\n+ \"search-result-layout.desktop.product-comparison\": { \n\n6\n\n+ \"allowed\": [\"product-comparison-drawer\"] \n\n7\n\n+ }, \n\n8\n\n \"store.product.product-comparison\": { \n\n9\n\n \"around\": [\"comparison-context-wrapper\"], \n\n10\n\n \"allowed\": [\"product-comparison-drawer\"] \n\n11\n\n } \n\n12\n\n+} \n\n`\n\n### Step 3 - Wrapping the search blocks with Product Comparison context\n\n1. In the theme's `search.jsonc` file, replace the default `store.search` blocks with the `store.search.product-comparison` blocks, as shown in the example below:\n\n`1\n\n{ \n\n2\n\n ... \n\n3\n\n- \"store.search\": { \n\n4\n\n+ \"store.search.product-comparison\": { \n\n5\n\n ... \n\n6\n\n }, \n\n7\n\n- \"store.search#brand\": { \n\n8\n\n+ \"store.search.product-comparison#brand\": { \n\n9\n\n ... \n\n10\n\n }, \n\n11\n\n- \"store.search#department\": { \n\n12\n\n+ \"store.search.product-comparison#department\": { \n\n13\n\n ... \n\n14\n\n } \n\n15\n\n- \"store.search#category\": { \n\n16\n\n+ \"store.search.product-comparison#category\": { \n\n17\n\n ... \n\n18\n\n } \n\n19\n\n- \"store.search#subcategory\": { \n\n20\n\n+ \"store.search.product-comparison#subcategory\": { \n\n21\n\n ... \n\n22\n\n } \n\n23\n\n ... \n\n`\n\n> The `store.search.product-comparison` blocks wrap the `store.search` block with comparison context. The replacement is needed to synchronously display the selected products in the Product Comparison drawer.\n\n1. Replace the `search-result-layout.desktop` blocks with the `search-result-layout.desktop.product-comparison` blocks, as shown below:\n\n`1\n\n{ \n\n2\n\n ... \n\n3\n\n\"search-result-layout\": { \n\n4\n\n \"blocks\": [ \n\n5\n\n- \"search-result-layout.desktop#search\" \n\n6\n\n+ \"search-result-layout.desktop.product-comparison#search\", \n\n7\n\n \"search-result-layout.mobile\", \n\n8\n\n \"search-not-found-layout\" \n\n9\n\n ] \n\n10\n\n}, \n\n`\n\n1. Replace the `product-summary.shelf`, child of the `gallery` block, with the `product-summary.shelf.product-comparison`:\n\n`1\n\n\"gallery\": { \n\n2\n\n- \"blocks\": [\"product-summary.shelf\"] \n\n3\n\n+ \"blocks\": [\"product-summary.shelf.product-comparison#search\"] \n\n4\n\n} \n\n5\n\n... \n\n`\n\n### Step 4 - Adding the Product Comparison to the product detail Page\n\n1. In the theme's `product.json` file, replace the default `store.product` blocks with the `store.product.product-comparison` blocks, as shown in the example below:\n\n`1\n\n \n2\n\n- \"store.product\": { \n\n3\n\n+ \"store.product.product-comparison\": { \n\n4\n\n ... \n\n5\n\n } \n\n`\n\n1. Add `product-comparison-drawer` to the `store.product.product-comparison` children, as shown in the example below:\n\n`1\n\n\"store.product.product-comparison\": { \n\n2\n\n children:[ \n\n3\n\n ... \n\n4\n\n+ \"product-comparison-drawer\" \n\n5\n\n ] \n\n6\n\n ... \n\n7\n\n} \n\n`\n\n1. Add `product-comparison-block.selector#pdp` to the `store.product.product-comparison` block, as shown in the example below:\n\n`1\n\n \"store.product.product-comparison\": { \n\n2\n\n ... \n\n3\n\n children:[ \n\n4\n\n ... \n\n5\n\n+ \"product-comparison-block.selector#pdp\" \n\n6\n\n ] \n\n7\n\n ... \n\n8\n\n } \n\n`\n\n### Step 5 - Building the Product Comparison component\n\nIn any desired template, such as `store.search`, add the `product-comparison-drawer` block, as shown below:\n\n`1\n\n- \"search-result-layout.desktop#search\": { \n\n2\n\n+ \"search-result-layout.desktop.product-comparison#search\": { \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#searchbread\", \n\n8\n\n \"flex-layout.row#searchtitle\", \n\n9\n\n \"flex-layout.row#result\", \n\n10\n\n+ \"product-comparison-drawer\" \n\n11\n\n ], \n\n12\n\n \"props\": { \n\n13\n\n \"pagination\": \"show-more\", \n\n14\n\n \"preventRouteChange\": false, \n\n15\n\n \"mobileLayout\": { \n\n16\n\n \"mode1\": \"small\", \n\n17\n\n \"mode2\": \"normal\" \n\n18\n\n } \n\n19\n\n } \n\n20\n\n} \n\n21\n\n... \n\n`\n\nBy adding the `product-comparison-drawer` block as shown above, you will declare the following structure behind the scenes:\n\n`1\n\n\"product-comparison-drawer\": { \n\n2\n\n \"blocks\": [\"list-context.comparison-product-summary-slider#drawer\"] \n\n3\n\n}, \n\n4\n\n\"list-context.comparison-product-summary-slider#drawer\": { \n\n5\n\n \"blocks\": [\"product-summary.shelf.product-comparison#drawer\"], \n\n6\n\n \"children\": [\"slider-layout#comparison-drawer\"] \n\n7\n\n}, \n\n8\n\n\"slider-layout#comparison-drawer\": { \n\n9\n\n \"props\": { \n\n10\n\n \"blockClass\": \"comparison-drawer\", \n\n11\n\n \"itemsPerPage\": { \n\n12\n\n \"desktop\": 4, \n\n13\n\n \"tablet\": 3, \n\n14\n\n \"phone\": 1 \n\n15\n\n }, \n\n16\n\n \"showPaginationDots\": \"never\", \n\n17\n\n \"infinite\": true, \n\n18\n\n \"fullWidth\": true \n\n19\n\n } \n\n20\n\n}, \n\n21\n\n\"product-summary.shelf.product-comparison#drawer\": { \n\n22\n\n \"children\": [ \n\n23\n\n \"product-summary-column#drawer-col2\", \n\n24\n\n \"product-comparison-block.close-button\" \n\n25\n\n ], \n\n26\n\n \"props\": { \n\n27\n\n \"blockClass\": \"drawer-summary\" \n\n28\n\n } \n\n29\n\n}, \n\n30\n\n\"product-summary-column#drawer-col2\": { \n\n31\n\n \"children\": [\"product-summary-name\", \"product-summary-price#comparison\"], \n\n32\n\n \"props\": { \n\n33\n\n \"blockClass\": \"drawer-summary-col2\" \n\n34\n\n } \n\n35\n\n}, \n\n36\n\n\"product-summary-price#comparison\": { \n\n37\n\n \"props\": { \n\n38\n\n \"showListPrice\": false, \n\n39\n\n \"showSellingPriceRange\": false, \n\n40\n\n \"showLabels\": false, \n\n41\n\n \"showInstallments\": false, \n\n42\n\n \"showDiscountValue\": false \n\n43\n\n } \n\n44\n\n} \n\n`\n\n> _The code above is a default implementation of the Product Comparison component. To make any changes, declare the code above in your theme and perform the needed updates according to the available blocks._\n\n### Step 6 - Building the Product Comparison page\n\n1. In the `/store/blocks` folder, create a new file called `product-comparison.json` and include the following JSON:\n\n`1\n\n\"store.custom#product-comparison-list\": { \n\n2\n\n \"blocks\": [\"comparison-page\"] \n\n3\n\n}, \n\n4\n\n \n5\n\n\"comparison-page\": { \n\n6\n\n \"children\": [\"slider-layout-group#comparison-page\"] \n\n7\n\n}, \n\n8\n\n \n9\n\n\"slider-layout-group#comparison-page\": { \n\n10\n\n \"children\": [ \n\n11\n\n \"product-comparison-block.product-summary-row\", \n\n12\n\n \"product-comparison-block.grouped-product-specifications\" \n\n13\n\n ] \n\n14\n\n}, \n\n15\n\n\"product-comparison-block.product-summary-row\": { \n\n16\n\n \"blocks\": [\"list-context.comparison-product-summary-slider#comparison-page\"] \n\n17\n\n}, \n\n18\n\n\"list-context.comparison-product-summary-slider#comparison-page\": { \n\n19\n\n \"blocks\": [\"product-summary.shelf.product-comparison#comparison-page\"], \n\n20\n\n \"children\": [\"slider-layout#comparison-page-product-summary\"] \n\n21\n\n}, \n\n22\n\n\"product-summary.shelf.product-comparison#comparison-page\": { \n\n23\n\n \"children\": [ \n\n24\n\n \"flex-layout.row\", \n\n25\n\n \"product-summary-image#comparison-page\", \n\n26\n\n \"product-summary-name\", \n\n27\n\n \"product-summary-space\", \n\n28\n\n \"product-summary-price#comparison\", \n\n29\n\n \"product-summary-buy-button\" \n\n30\n\n ], \n\n31\n\n \"props\": { \n\n32\n\n \"blockClass\": \"comparison-page-summary\" \n\n33\n\n } \n\n34\n\n}, \n\n35\n\n\"flex-layout.row\": { \n\n36\n\n \"children\": [\"product-comparison-block.close-button\"], \n\n37\n\n \"props\": { \n\n38\n\n \"blockClass\": \"close\", \n\n39\n\n \"horizontalAlign\": \"right\" \n\n40\n\n } \n\n41\n\n}, \n\n42\n\n\"product-summary-image#comparison-page\": { \n\n43\n\n \"props\": { \n\n44\n\n \"width\": 200, \n\n45\n\n \"heightProp\": 200 \n\n46\n\n } \n\n47\n\n}, \n\n48\n\n\"product-comparison-block.grouped-product-specifications\": { \n\n49\n\n \"blocks\": [\"list-context.comparison-row#comparison-page-row\"] \n\n50\n\n}, \n\n51\n\n\"list-context.comparison-row#comparison-page-row\": { \n\n52\n\n \"children\": [\"slider-layout#comparison-no-arrows\"] \n\n53\n\n}, \n\n54\n\n\"slider-layout#comparison-page-product-summary\": { \n\n55\n\n \"props\": { \n\n56\n\n \"blockClass\": \"comparison-page\", \n\n57\n\n \"itemsPerPage\": { \n\n58\n\n \"desktop\": 4, \n\n59\n\n \"tablet\": 3, \n\n60\n\n \"phone\": 1 \n\n61\n\n }, \n\n62\n\n \"showPaginationDots\": \"never\", \n\n63\n\n \"infinite\": true, \n\n64\n\n \"fullWidth\": true \n\n65\n\n } \n\n66\n\n}, \n\n67\n\n\"slider-layout#comparison-no-arrows\": { \n\n68\n\n \"props\": { \n\n69\n\n \"itemsPerPage\": { \n\n70\n\n \"desktop\": 4, \n\n71\n\n \"tablet\": 3, \n\n72\n\n \"phone\": 1 \n\n73\n\n }, \n\n74\n\n \"showPaginationDots\": \"never\", \n\n75\n\n \"infinite\": true, \n\n76\n\n \"fullWidth\": true, \n\n77\n\n \"blockClass\": \"comparison-page\", \n\n78\n\n \"showNavigationArrows\": \"never\" \n\n79\n\n } \n\n80\n\n} \n\n`\n\n1. In the theme's `routes.json` file, add a new route for the Product Comparison page:\n\n`1\n\n+{ \n\n2\n\n+ \"store.custom#product-comparison-list\": { \n\n3\n\n+ \"path\": \"/product-comparison\" \n\n4\n\n+ } \n\n5\n\n+} \n\n`\n\n#### `product-comparison-block.grouped-product-specifications` props\n\n| Prop name | Type | Description | Default value |\n| -------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| productSpecificationsToHide | \\[string\\] | List of product fields that should be hidden in the Product Comparison page. The desired product fields must be separated by a comma. | undefined |\n| productSpecificationGroupsToHide | \\[string\\] | List of product specification groups that should be hidden on the Product Comparison page. The desired product specification groups must be separated by a comma. | undefined |\n\n#### `product-comparison-block.product-specifications` props\n\n| Prop name | Type | Description | Default value |\n| --------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| productSpecificationsToHide | \\[string\\] | List of product fields that should be hidden in the Product Comparison page. The desired product fields must be separated by a comma. | undefined |\n\n#### `product-comparison-block.sku-specifications` props\n\n| Prop name | Type | Description | Default value |\n| ----------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| skuSpecificationsToHide | \\[string\\] | List of SKU specification fields that should be hidden on the Product Comparison page. The desired SKU specification fields must be separated by a comma. | undefined |\n\n#### `product-comparison-block.product-summary-row` props\n\n| Prop name | Type | Description | Default value |\n| ----------------------- | ------- | --------------------------------------------------------------------------------------------- | ------------- |\n| isShowDifferenceDefault | boolean | Set the \"show only differences\" checkbox to true as the default value on the comparison page. | false |\n| \\======= | | | |\n\n### Step 7 - Change the comparison bucket size\n\nThis is an optional configuration, so you can set a fixed number in the app configuration to change the maximum number of items in the comparison bucket. The default value is 10 items; if you exceed the maximum limit, you will receive a notification.\n\n#### Instructions\n\n1. Go to `/admin/apps`, then find the `Product Comparison` app under `Installed` apps.\n2. Click Settings.\n3. Enter the maximum comparison bucket size for your application.\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the instructions in [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| closeButton |\n| closeButtonContainer |\n| compareProductsButton |\n| comparisonButtons |\n| comparisonCol |\n| drawer |\n| drawerContainer |\n| expandCollapseButton |\n| fieldNameCol |\n| fieldNameCol |\n| productFieldValue |\n| productSelectorContainer |\n| productSpecificationValue |\n| productSpecificationValues |\n| productSummaryRowContainer |\n| rowContainer |\n| showDifferencesContainer |\n| skuFieldValue |\n| skuSpecificationValue |\n| skuSpecificationValues |\n| title |\n| removeAllItemsButtonWrapper |\n| compareProductButtonWrapper |\n| removeAllWrapper |\n| drawerTitleOuterContainer |\n| drawerTitleInnerContainer |\n| drawerOpened |\n| drawerClosed |\n\n[Product Availability« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-availability)[Product GiftsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-gifts)\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-comparison/docs/apps/vtex.product-comparison%23configuration)\n\n[Step 1 - Adding the Product Comparison app to your theme's dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-1-adding-the-product-comparison-app-to-your-themes-dependencies)[Step 2 - Adding extended interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-2-adding-extended-interfaces)[Step 3 - Wrapping the search blocks with Product Comparison context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-3-wrapping-the-search-blocks-with-product-comparison-context)[Step 4 - Adding the Product Comparison to the product detail Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-4-adding-the-product-comparison-to-the-product-detail-page)[Step 5 - Building the Product Comparison component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-5-building-the-product-comparison-component)[Step 6 - Building the Product Comparison page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-6-building-the-product-comparison-page)[Step 7 - Change the comparison bucket size](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-7-change-the-comparison-bucket-size)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%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_7b910d87
|
[
{
"role": "system",
"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 recaptcha 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/recaptcha/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/api-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/recaptcha/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/recaptcha/docs/storefront-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/recaptcha/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/recaptcha/docs/troubleshooting)\n\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/recaptcha/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha)\n\n[Applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/applicable-cases)\n\n[Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/implementing-recaptcha-in-integrations)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/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/recaptcha/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha)\n\n[Applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/applicable-cases)\n\n[Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/implementing-recaptcha-in-integrations)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/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/recaptcha/docs/guides)\n\nIntegration Guides\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha)\n\nreCAPTCHA\n\nreCAPTCHA is a tool used to determine if a given action is performed by a real user or malicious automation. Therefore, it is particularly helpful in preventing ecommerce fraud.\n\nThis guide shows you how to implement this feature in checkout integrations. To learn more about this type of validation in VTEX stores, see this [article on reCAPTCHA](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP) on our help center.\n\n> VTEX is integrated with reCAPTCHA enterprise, which offers two validation approaches: checkbox (equivalent to reCAPTCHA v2) and score-based (equivalent to reCATPCHA v3). See this article on [reCAPTCHA at VTEX Checkout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP%23recaptcha-versions) to learn what version you should use depending on your storefront characteristics. You can also learn more each method: [reCAPTCHA v2](https://read.calvincode.net/reader?url=https://developers.google.com/recaptcha/docs/display) or [reCAPTCHA v3](https://read.calvincode.net/reader?url=https://developers.google.com/recaptcha/docs/v3) with the documentation provided by Google.\n\nTo configure reCAPTCHA verification, follow the steps below:\n\n1. Make a `GET` request using the endpoint [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm).\n2. Make a `POST` request using the endpoint [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) with the same data obtained in the GET request, just modifying the `recaptchaValidation` parameter to one of the following values: \n * `\"never\"`: no purchases are validated with reCAPTCHA. \n * `\"always\"`: all purchases are validated with reCAPTCHA. This is the recommended option if you are using score-based validation (equivalent to reCATPCHA v3). \n * `\"vtexCriteria\"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve the shopping experience. VTEX’s algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option if you are using checkbox validation (equivalent to reCAPTCHA v2).\n3. Make a new `GET` request using the endpoint [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm) to confirm activation.\n\nThis configuration is valid for the entire account. It is not possible to activate reCAPTCHA for a limited number of [bindings](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/o-que-e-binding--4NcN3NJd0IeYccgWCI8O2W%23).\n\n> If you activate reCAPTCHA for your account, it is important to note that any integrations that deal with placing orders should be able to handle the validation. If reCAPTCHA is required for a given order, it can not be placed without validation. However, if your store uses VTEX’s native UI, it is already capable of handling reCAPTCHA. ⚠️ If you are implementing a headless checkout experience in your store or even carrying out order creation tests via API, reCAPTCHA in active mode can block order completion requesting the reCAPTCHA validation key that is not possible to generate only via API, its only possible to generate displaying the reCAPTCHA widget.\n\nLearn more about the [applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/applicable-cases) and [how to implement reCAPTCHA for Checkout integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/implementing-recaptcha-in-integrations).\n\n## reCAPTCHA score\n\nScore-based reCAPTCHA returns a score for the user interaction at your store. Possible values are `0.1`, `0.3`, `0.7` and `0.9`, where `1.0` is is very likely a good interaction and `0.0` is very likely a bot. Learn more about [how to interpret this score](https://read.calvincode.net/reader?url=https://developers.google.com/recaptcha/docs/v3?%23interpreting%5Fthe%5Fscore).\n\nIf you are implementing score-based reCAPTCHA, you have the option to set a minimum score for each [key that you create](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations%23getting-the-recaptcha-key-for-mobile-implementations) and set a minimum score for your account.\n\nThe priority order of score application for any given purchase is:\n\n`1\n\nreCAPTCHA key score > Account score > VTEX default score (0.7) \n\n`\n\nThis means that if you set minimum scores for both your key and account, the minimum score of the key will be applied. On the other hand, if you set neither, VTEX will apply the default value of `0.7`.\n\nInteractions that return a value lower than the minimum value applicable will not be able to place orders.\n\n### Setting an account minimum score\n\nTo set a minimum score for your account, follow the steps below:\n\n1. Make a `GET` request using the endpoint [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm).\n2. Make a `POST` request using the endpoint [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) with the same data obtained in the GET request, just adding or modifying the value of the field `recaptchaMinScore`, which is a decimal number.\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/recaptcha.md)\n\n[Pricing Hub« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha//docs/guides/pricing-hub)[Applicable casesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha//docs/guides/applicable-cases)\n\nContributors\n\n2\n\n[](https://github.com/PedroAntunesCosta)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[reCAPTCHA score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha%23recaptcha-score)\n\n[Setting an account minimum score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha%23setting-an-account-minimum-score)\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/recaptcha.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[reCAPTCHA score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha%23recaptcha-score)\n\n[Setting an account minimum score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha%23setting-an-account-minimum-score)\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_922fa422
|
[
{
"role": "system",
"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 organization units 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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-api/docs/api-reference/organization-units-api/)\n\nUsers\n\nOrganization Units\n\nScopes\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-api/docs/api-reference/organization-units-api/)\n\nUsers\n\nOrganization Units\n\nScopes\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-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/organization-units-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoAdd Log in Orders« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/interactions)[GeGet user scopesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/organization-units-api%23get-/api/organization-units/v1/users/-userId-/scopes)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e2902fdf
|
[
{
"role": "system",
"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 productbrand 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-productbrand/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-productbrand/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/updates/release-notes)\n\nProduct Brand\n\nThe `product-brand` block displays either the **name** or the **logo** of a product's brand.\n\n\n\n## Before you begin\n\nEnsure that you have registered [brands](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-brand--QU07yhHoaWcEYseEucOQW) in your store. To do so, follow the [How to register brands](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/registering-brands--tutorials%5F1414) documentation.\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-brand` block to any child of the `store.product` template (Product Details Page template). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"product-brand\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `product-brand` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n\"product-brand\": { \n\n2\n\n \"props\": { \n\n3\n\n \"displayMode\": \"text\" \n\n4\n\n } \n\n5\n\n }, \n\n`\n\n### Configuration\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| brandId | number | The brand ID. If no value is declared, the product context should provide the data. | undefined |\n| brandName | string | The brand name. If no value is declared, the product context should provide the data. | undefined |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n| displayMode | string | Defines if the product brand will be displayed by name or logo. Possible values are logo and text. | logo |\n| excludeBrands | array | The brand names or brand IDs listed in the array will never be displayed by the Brand component. It is usually useful to hide default or test brand names/logos on the store front. | undefined |\n| fallbackToText | boolean | Defines the behavior of the Product Brand block when set to display a brand logo but no image is registered in the VTEX admin's Catalog. If true, it allows the logo to be replaced with the brand name. If false, neither the brand name nor the brand logo are displayed. **This prop is only available for the logo display mode.** | true |\n| height | number | The logo height. **This prop is only available for the logo display mode.** | 100 |\n| loadingPlaceholder | string | Defines if the loading placeholder should have the size of the logo or the text. Possible values are: logo and text. | undefined |\n| logoWithLink | boolean | An error occurred while loading the image https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-components-productbrand-1.png Use withLink instead | false |\n| withLink | enum | Defines the scenarios in which the product brand should have a link that leads to its website. Possible values are: none (never includes the link), logo (includes the link whenever the brand logo is displayed), text (includes the link whenever the brand name is displayed), and logoAndText (includes the link whenever the brand logo or the brand name is displayed). | none |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ----------------------- |\n| productBrandContainer |\n| productBrandName |\n| productBrandLogo |\n| productBrandLogoWrapper |\n| productBrandLogoLink |\n| productBrandNameLink |\n| productBrandLogoSpacer |\n| productBrandNameSpacer |\n\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-productbrand.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/guides/vtex-store-components-productbrand%23before-you-begin)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/guides/vtex-store-components-productbrand%23configuration)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/guides/vtex-store-components-productbrand%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/guides/vtex-store-components-productbrand%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-productbrand.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-store-components-productbrand/docs/guides/vtex-store-components-productbrand%23before-you-begin)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/guides/vtex-store-components-productbrand%23configuration)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/guides/vtex-store-components-productbrand%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productbrand/docs/guides/vtex-store-components-productbrand%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_212a3341
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting my pages are taking too long to be published on headless cms in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting)\n\nDevelopment\n\nMy pages are taking too long to be published on Headless CMS\n\nReleasing or publishing a page via Headless CMS or Releases can take a long build times\n\n**Tags:** Headless CMS, Releases, FastStore\n\n**Keywords:** Build, deploy, FastStore\n\nWhen releasing or publishing a page via [Headless CMS](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/headless-cms-overview--3U5gvhHdQL0jczYH8gjX09) or [Releases](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/releases-module-beta--n2tN0WX5I6MJMbrJrS0Kb), you may experience long build times.\n\n## Solution\n\nFollow the steps below to identify the root cause of publishing errors with the VTEX Headless CMS and Releases module.\n\n### Step 1: Check the release status\n\nIn the VTEX Admin, go to **Storefront > Releases**, and click **Releases**.\n\nCheck if the page release status is either **Published** or **Failed**.\n\nOpen the release and copy its identifier (e.g., `635feddd372d5fef67c4160e`) at the end of the page URL (e.g., `https://{accountname}.myvtex.com/admin/releases/calendar/?period=ONE_DAY-1708916400000&release=635feddd372d5fef67c4160e&search=&sort=LAST_MODIFIED&sort=DESC&status=ALL`). After copying the identifier, proceed to [Checking the GitHub pipeline](#step-2-check-the-github-pipeline) to continue checking the status.\n\n### Step 2: Check the GitHub pipeline\n\nAfter [getting the Release identifier](#step-1-check-the-release-status), follow these steps to verify the status of the corresponding build.\n\n1. Access the GitHub repository of your FastStore project.\n2. In the repository search field, search for the code obtained in the [previous section](#step-1-check-the-release-status). If you find a commit with the corresponding Release identifier in its name, it indicates that the Release has undergone the CI/CD process.\n3. Check the status of the **Build check** for the commit by clicking one of the following icons:\n\n| Icon | Description |\n| ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| ✓ | The build was successful. If this status doesn't match what you see in the Admin, the communication between the Releases module and WebOps must have failed. No action is required, as this error is related to a communication issue on our end. |\n| ● | The build is queued, waiting for other builds to complete. If queued for longer than 45 minutes, please [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk). |\n| ⨯ | The build failed. For more details, proceed to \\[Step 3 - Identifying the build error\\](#step-3 -identifying the build error). |\n\n### Step 3 - Identify the build error\n\nIf the Release's build failed, follow these instructions to identify the root cause of the error:\n\n1. Click the **Details** link next to the **Build** check to view the full log. \n\n2. Click the **Re-run checks** button to try deploying your Release again. \n> If the **Re-run checks** button is not available, you might not have _write access_ to the repository. In this case, contact the repository's Admin.\n3. If the error persists, review the build log, check the error, and [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk) with a description of the issue.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/my-pages-are-taking-too-long-to-be-published-on-headless-cms.md)\n\n[My store catalog does not display the price range filter« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)[My store does not reflect the overrides I createdNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms%23solution)\n\n[Step 1: Check the release status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms%23step-1-check-the-release-status)[Step 2: Check the GitHub pipeline](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms%23step-2-check-the-github-pipeline)[Step 3 - Identify the build error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms%23step-3-identify-the-build-error)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/my-pages-are-taking-too-long-to-be-published-on-headless-cms.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms%23solution)\n\n[Step 1: Check the release status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms%23step-1-check-the-release-status)[Step 2: Check the GitHub pipeline](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms%23step-2-check-the-github-pipeline)[Step 3 - Identify the build error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms%23step-3-identify-the-build-error)\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_515cb80d
|
[
{
"role": "system",
"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 logo 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/logo/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/logo/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/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/logo/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/logo/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/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/logo/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/logo/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/logo/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/logo/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/logo/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/logo/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/logo/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/logo/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/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/logo/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/logo/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/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/logo/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/logo/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/logo/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/logo/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/logo/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/logo/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/logo/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/logo/docs/vtex-io-apps)\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/guides/store-components)\n\nLogo\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 `logo` block displays a logo in the store header.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `logo` block into the [header](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-header/) component. For example:\n\n`1\n\n \"header.full\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"login\", \n\n4\n\n \"minicart\", \n\n5\n\n+ \"logo\", \n\n6\n\n \"search-bar\", \n\n7\n\n \"menu-link\", \n\n8\n\n \"telemarketing\", \n\n9\n\n \"category-menu\" \n\n10\n\n ] \n\n11\n\n }, \n\n`\n\n1. Then, declare the `logo` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"logo\": { \n\n2\n\n \"props\": { \n\n3\n\n \"width\": 132, \n\n4\n\n \"height\": 32, \n\n5\n\n \"mobileWidth\": 90, \n\n6\n\n \"mobileHeight\": 32 \n\n7\n\n } \n\n8\n\n } \n\n9\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n| color | String | The image fill color. | #F71963 |\n| height | Number | The logo image height. | 177 |\n| href | String | The image hyperlink. | undefined |\n| showLabel | Boolean | The label visibility. | true |\n| title | String! | The image alt description. | VTEX logo |\n| url | String | The image soure URL. | undefined |\n| width | Number | The logo image width. | 493 |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------- |\n| logoContainer |\n| logoImage |\n| logoLink |\n| sizeDesktop |\n| sizeMobile |\n\n[Info Card« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/infocard)[NotificationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/notification)\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/logo/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/logo/docs/apps/vtex.store-components/logo%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/logo%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo/docs/apps/vtex.store-components/logo%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_cc03a7ea
|
[
{
"role": "system",
"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 shareasale 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.shareasale/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/api-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.shareasale/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.shareasale/docs/storefront-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.shareasale/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.shareasale/docs/troubleshooting)\n\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.shareasale/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/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.shareasale/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/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.shareasale/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.shareasale/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/guides/pixel-apps)\n\nShareasale\n\nOfficial extension\n\nVersion: 1.0.3\n\nLatest version: 1.0.3\n\nVTEX Shareasale first-party app\n\n## How to install\n\nOpen the VTEX App Store and install this app on your store.\n\nNow, open the app settings on your admin and fill in your Shareasale's Merchant ID and Transaction Type.\n\n[Search Console« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.google-search-console)[smarthintNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.smarthint)\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[How to install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shareasale/docs/apps/vtex.shareasale%23how-to-install)\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_cb06d453
|
[
{
"role": "system",
"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 business guidelines vtex app store in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store/updates/release-notes)\n\nBusiness guidelines\n\n* [App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23paid-distribution)\n* [Self-service level](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level)\n* [Marketing assets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\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/homologation-requirements-for-the-vtex-app-store/vtex-io-documentation-business-guidelines-vtex-app-store.md)\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/Perks/homologation-requirements-for-the-vtex-app-store/vtex-io-documentation-business-guidelines-vtex-app-store.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b31df692
|
[
{
"role": "system",
"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 composability 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/composability/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/api-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/composability/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/composability/docs/storefront-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/composability/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/composability/docs/troubleshooting)\n\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/composability/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability)\n\n[VTEX Composable Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/vtex-composable-components)\n\n[Interactive Marchitecture tool](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/interactive-marchitecture-tool)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/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/composability/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/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/composability/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/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/composability/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/composability/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability)\n\n[VTEX Composable Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/vtex-composable-components)\n\n[Interactive Marchitecture tool](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/interactive-marchitecture-tool)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/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/composability/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/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/composability/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/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/composability/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/composability/docs/guides)\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/vtex-platform-overview)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability)\n\nComposability\n\nUnderstand what makes VTEX a Composable and Complete ecommerce solution.\n\nComposability in ecommerce allows merchants to build and customize online shopping experiences by combining modular components or services. A composable commerce platform consists of loosely coupled microservices, enabling merchants to:\n\n* Choose which services to use.\n* Choose alternative service providers.\n* Customize services.\n\nIn this guide, we will explain VTEX’s approach to composability and provide an overview of the VTEX Commerce Platform's composable features.\n\n## VTEX: Composable and complete\n\nOur platform stands out for its composability and comprehensive features, offering a flexible and robust solution for digital commerce.\n\nVTEX provides **composability** by:\n\n* Allowing businesses to choose and customize services and integrations.\n* Supporting native services and third-party providers.\n\nVTEX offers a **complete** platform through:\n\n* Core modules that support running a full ecommerce operation.\n* Multiple combinations of native services, extensions, integrations, and add-ons.\n* Development frameworks for creating custom solutions.\n\nTo take full advantage of our composable features, we recommend using VTEX as the commerce engine and combining it with integrations, extensions, and add-ons. The platform is flexible enough that merchants can change the store configuration over time. Start by using as many native features as possible, then gradually extend and exchange for external solutions.\n\nHere are some features that demonstrate how VTEX is composable and complete:\n\n* [750+ API endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference)\n* 900+ live connections, including [payment providers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/list-of-payment-providers-by-country--2im3BEGXxSAcRuxEaIHPvp) and [marketplaces](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials%5F402%23integrating-with-a-certified-marketplace)\n* [No-code extensibility through the VTEX Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/extensions-hub--AW7klkYMh557y5IUOgzco/3lWdpzjyhHVwzMC7pTG0QS)\n* Services that emit [events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events) and [logs](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/audit--5RXf9WJ5YLFBcS8q8KcxTA)\n* [70+ decoupled microservices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides)\n* [Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-commerce)\n* [Multi-tenant infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cloud-infrastructure%23saas-multi-tenancy)\n* [Auto-scalable servers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cloud-infrastructure%23scalability)\n* [Extensible VTEX IO apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n* [Documented integration protocols to guide and accelerate implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide)\n* [Customizable and extensible data models](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw)\n\n## Pragmatic Composability\n\nPragmatic Composability is the digital commerce architectural approach that empowers merchants to leverage the native services of our ecommerce platform for their core needs and selectively compose custom-built and best-of-breed applications that will deliver a business advantage.\n\nOn VTEX, merchants can choose how composable their stores will be. They can be completely native, full of integrations and customizations, or something in between. Generalizing the many composition possibilities, we came up with four cases that represent the levels of composability regarding the commerce experience, illustrated below.\n\n\n\n> The most appropriate model will depend on the level of digital maturity and specialization needed for each business. In these cases, merchants use VTEX as the commerce engine and choose which components of the commerce experience will be decoupled.\n> \n> Choosing a case or set of features at the beginning does not exclude the possibility of changing the architecture later. Over time, adding new features and decoupling functions with third-party integrations is possible.\n\nLearn more about each model in the following sections.\n\n### Complete Platform\n\nThe complete platform case uses mostly VTEX's native features, including frontend application and infrastructure, [CMS (Content Management System)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/6OCY6S9tqBXPD5mgpbBInC), [Search](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG), [commerce modules](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/75MX4aorniD0BYAB8Nwbo7), and [APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis). This option often offers the quickest time to market and the lowest total cost of ownership. VTEX takes care of all maintenance and updates of its native modules while also allowing frontend and backend customizations via [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io), if merchants wish to create them. Besides, there is no time spent configuring or implementing integrations, and no additional cost from third-party providers.\n\n### Headless Commerce\n\nThis case uses a Digital Experience Platform (DXP) decoupled from the native commerce infrastructure. As a single provider, the DXP usually handles the Storefront Application, Frontend Infrastructure, CMS, and Search & Personalization. A headless model with a single DXP provider is a good option for building a store’s frontend from scratch without having to handle multiple frontend systems and the commerce infrastructure.\n\n> VTEX has a native service that allows developers to build headless storefronts: [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore), a starter headless storefront that uses VTEX infrastructure. FastStore can be customized, extended, and combined with [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) and [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG).\n\n### Frontend as a Service (FEaaS)\n\nThe FEaaS option may be ideal for companies looking for a specific search solution or CMS and who want to use the same content in several channels. It is a common scenario where the company already uses a specific search provider or CMS before migrating to VTEX.\n\nIn this case, they can combine a third-party FEaaS provider with independent CMS and search solutions. Given the multiple systems involved and the need to orchestrate all of them, this can become more expensive to use and maintain.\n\n> [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore) can also work as the FEaaS with third-party CMS and search solutions.\n\n### Best of Breed\n\nFor maximum composability and flexibility, businesses with a mature development team or willing to pay specialized agencies may choose this model, selecting a best-of-breed provider for each commerce module. This option is the most appropriate when merchants want complete control over the deployment and infrastructure layers. Still, it means higher implementation time, increased costs, and the development of an API Gateway or a Backend for Frontend (BFF) layer. In addition, it will require handling multiple vendors for integrations.\n\nProjects of this kind may take years to implement, but merchants can progressively integrate each module. VTEX has the advantage of having native solutions for each module, enabling a faster time to market.\n\n> Although we identify these four cases, pragmatic composability allows for many other combinations of composing your architecture. For details of types of architectures in specific scenarios, see our [Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-architecture) guide.\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\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-Platform-Overview/Composability/composability.md)\n\n[Data privacy« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability//docs/guides/data-privacy)[VTEX Composable ComponentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability//docs/guides/vtex-composable-components)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[VTEX: Composable and complete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23vtex-composable-and-complete)\n\n[Pragmatic Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23pragmatic-composability)\n\n[Complete Platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23complete-platform)[Headless Commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23headless-commerce)[Frontend as a Service (FEaaS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23frontend-as-a-service-feaas)[Best of Breed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23best-of-breed)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Platform-Overview/Composability/composability.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[VTEX: Composable and complete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23vtex-composable-and-complete)\n\n[Pragmatic Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23pragmatic-composability)\n\n[Complete Platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23complete-platform)[Headless Commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23headless-commerce)[Frontend as a Service (FEaaS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23frontend-as-a-service-feaas)[Best of Breed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability/docs/guides/composability%23best-of-breed)\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_19db029a
|
[
{
"role": "system",
"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 skuselector 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-skuselector/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-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/guides/vtex-store-components-skuselector/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/vtex-io-apps)\n\nSKU Selector\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\nThe `sku-selector` block is mainly used in Product Details Pages (PDPs) to display all the SKUs available for a product.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `sku-selector` block to any child of the `store.product` template (product page). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"sku-selector\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `sku-selector` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"sku-selector\": { \n\n2\n\n \"props\": { \n\n3\n\n \"hideImpossibleCombinations\": false \n\n4\n\n } \n\n5\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, please refer to [this documentation](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Please note that this is only helpful if you're using this block as a React component. | undefined |\n| disableUnavailableSelectOptions | boolean | Whether a product variation that leads to an impossible product combination should be displayed with the disabled attribute when displayMode is set to select. By default, all select options are configured without the disabled attribute set based on the type of variation | false |\n| displayMode | enum | Defines how the product variation names will be displayed (it does not apply to product variation images). Possible values are: default (displays all variation names), select (only displays the selected variation name), or slider (displays all variation names in a slider when the number of available options is greater than the value defined in the sliderDisplayThreshold prop). Please note that this prop is _responsive_, so you can declare an object as its value, specifying a value for each breakpoint (desktop and mobile). | default |\n| hideImpossibleCombinations | boolean | Defines whether a product variation should be clickable (true) or (false). The variation will not be displayed if true. If false, the variation will be displayed with less opacity. For example, there are two colors for a pair of sneakers: pink and white. If the pink sneaker is only available in one size, the other sizes will not be displayed (true). | true |\n| sortVariationsByLabel | boolean | Defines if the variations are to be sorted in alphabetical order. | false |\n| imageHeight | number | object | Height (in px) of the product thumbnail image. You can declare an object as its value in case you want to define a height for each device (desktop and mobile). |\n| imageWidth | number | object | Width (in px) of the product thumbnail image. You can declare an object as its value in case you want to define a width for each device (desktop and mobile). |\n| initialSelection | enum | Controls the user's initial selection for available variations when the product page is fully loaded. Possible values are: complete (selects the first available SKU variation values), image (selects the first available image variation), or empty (no variations will be selected when the page is loaded). | complete |\n| maxItems | number | The maximum number of variation items to be displayed in the SKU selector before the See more button. The button will always be displayed 2 items before the number set in maxItems. | 10 |\n| showValueForVariation | enum | Displays a value for the selected variation. This prop replaces the former showValueNameForImageVariation (deprecated). Possible values are: none (no values are displayed when the variation is selected), image (displays only the image value for the selected variation, if any), or all (all variation values are displayed). | none |\n| sliderArrowSize | number | Controls the size (height and width) in pixels of the navigation arrows rendered when displayMode is set as slider. | 12 |\n| sliderDisplayThreshold | number | The minimum number of product variation names that should be displayed using slider display mode. This prop only works properly when displayMode is set as slider. | 3 |\n| sliderItemsPerPage | object | Controls how many slides should be displayed on each type of device when displayMode is set as slider. There is more information regarding this prop structure below this table. | {desktop: 3, tablet: 2, phone: 1} |\n| showVariationsErrorMessage | boolean | Whether an error message should be displayed when the BuyButton is clicked but no available variation was selected (true) or (false). | true |\n| showVariationsLabels | enum | Where variation names should be displayed. Possible values are: none (does not display the variation names). Replaces the previous false behavior), variation (displays the variation name as a header of the items. Replaces the previous true behavior), itemValue (displays the variation name before each item's value), and variationAndItemValue (behaves as variation and itemValue at the same time). | variation |\n| thumbnailImage | string | The first image to be displayed. This prop value must be the same text string defined in the desired product image imageLabel field (from the Catalog module). If you use this prop and no image declaring the same text string in its imageLabel field is found, any product image will be randomly rendered. To apply the thumbnailImage configuration, please read the [Configuring custom images for the SKU Selector documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector) | undefined |\n| variationsSpacing | number | Defines the margin-bottom size to be applied in the rendered product variations. Possible values range from 0 to 11 (the prop value is not in px; every value represents a tachyon class). | 7 |\n| visibility | enum | Defines the scenarios in which the SKU selector should be displayed. Possible values are: always (it will always be displayed, even if the product has only one SKU option) or more-than-one (the SKU selector is only displayed when the product has more than one SKU option). | always |\n| visibleVariations | array | Specifies which product variations should be displayed on the product details page. Please note that no variations will be displayed if you declare a name that does not represent a real product variation or an empty array. There is more information regarding this prop structure below this table. | undefined |\n\n* **`visibleVariations` props**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ----------------------- | ------------- |\n| name | string | Product variation name. | undefined |\n\n* **`sliderItemsPerPage` props**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------------------------------------------------------------------ | ------------- |\n| desktop | number | The number of slides to be displayed on desktop devices when displayMode is set as slider. | 3 |\n| tablet | number | The number of slides to be displayed on tablet devices when displayMode is set as slider. | 2 |\n| phone | number | The number of slides to be displayed on phone devices when displayMode is set as slider. | 1 |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, please see the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ----------------------------- |\n| frameAround |\n| seeMoreButton |\n| skuSelectorContainer |\n| skuSelectorInternalBox |\n| skuSelectorItemImageValue |\n| skuSelectorItemImage |\n| skuSelectorItemTextValue |\n| skuSelectorItem |\n| skuSelectorNameContainer |\n| skuSelectorNameSeparator |\n| skuSelectorName |\n| skuSelectorOptionsList |\n| skuSelectorSelectorImageValue |\n| skuSelectorSubcontainer |\n| skuSelectorTextContainer |\n| valueWrapper |\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/apps/vtex.store-components/SKUSelector%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/apps/vtex.store-components/SKUSelector%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector/docs/apps/vtex.store-components/SKUSelector%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_50f53005
|
[
{
"role": "system",
"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 vtex gift cards 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-vtex-gift-cards/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/api-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-vtex-gift-cards/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-vtex-gift-cards/docs/storefront-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-vtex-gift-cards/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-vtex-gift-cards/docs/troubleshooting)\n\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-vtex-gift-cards/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/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/managing-vtex-gift-cards/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/gift-card-integration-guide)\n\n[Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/gift-card-integration-guide-system-architecture)\n\n[Managing VTEX gift cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/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/managing-vtex-gift-cards/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/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/managing-vtex-gift-cards/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/gift-card-integration-guide)\n\n[Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/gift-card-integration-guide-system-architecture)\n\n[Managing VTEX gift cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/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/managing-vtex-gift-cards/docs/guides)\n\nIntegration Guides\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/gift-card-integration-guide)\n\n[Managing VTEX gift cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards)\n\nManaging VTEX gift cards\n\nThis guide describes how to manage VTEX native gift cards from the VTEX gift card provider through the [GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23overview). With this API, you can perform the following actions:\n\n* [Create a VTEX gift card](#creating-a-vtex-gift-card)\n* [Check VTEX gift card details](#checking-vtex-gift-card-details)\n* [Create VTEX gift card transactions](#creating-vtex-gift-card-transactions)\n* [Check VTEX gift card transactions](#checking-vtex-gift-card-transactions)\n* [Cancel a VTEX gift card transaction](#cancelling-a-vtex-gift-card-transaction)\n\n> You can also manage VTEX gift cards using your store Admin. For more information, see [Setting up Gift Cards](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/gift-card--tutorials%5F995).\n\n## Creating a VTEX gift card\n\nTo create a VTEX gift card, you can use the [Create GiftCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23post-/giftcards) endpoint. In this request, you must send the information of the gift card you want to create.\n\n**POST**\n\n`https://{accountName}.{environment}.com.br/api/giftcards`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"relationName\": \"loyalty-program-test\", \n\n3\n\n \"expiringDate\": \"2024-01-01T00:00:00\", \n\n4\n\n \"caption\": \"Vtex Loyalty Test\", \n\n5\n\n \"profileId\": \"92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff\", \n\n6\n\n \"restrictedToOwner\": false, \n\n7\n\n \"currencyCode\": \"BRL\", \n\n8\n\n \"multipleCredits\": true, \n\n9\n\n \"multipleRedemptions\": false \n\n10\n\n} \n\n`\n\nThe endpoint will return some of the previously sent detailsand new information about the created gift card, such as:\n\n* `\"id\"`: gift card identification.\n* `\"redemptionToken\"`: gift card redemption token.\n* `\"redemptionCode\"`: gift card redemption code.\n* `\"balance\"`: gift card balance.\n* `\"emissionDate\"`: gift card issue date.\n* `\"transaction\"`: transaction code for the create gift card operation.\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74\", \n\n3\n\n \"redemptionToken\": \"COCW-OZYZ-BEXN-TIMU\", \n\n4\n\n \"redemptionCode\": \"COCW-OZYZ-BEXN-TIMU\", \n\n5\n\n \"balance\": 0.0, \n\n6\n\n \"relationName\": \"loyalty-program-test\", \n\n7\n\n \"emissionDate\": \"2023-08-23T16:20:01.0479856Z\", \n\n8\n\n \"expiringDate\": \"2024-01-01T00:00:00\", \n\n9\n\n \"caption\": \"Vtex Loyal Test\", \n\n10\n\n \"currencyCode\": \"BRL\", \n\n11\n\n \"discount\": false, \n\n12\n\n \"transaction\": { \n\n13\n\n \"href\": \"/cosmetics2/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions\" \n\n14\n\n } \n\n15\n\n} \n\n`\n\nYou can also access your store Admin (**Promotions > Gift Cards**) to confirm that the new gift card was created.\n\n\n\n> All gift cards created via API have no balance (value 0). You can add balance amounts to new gift cards through the [Create GiftCard Transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23post-/giftcards/-giftCardID-/transactions) endpoint or the VTEX Admin.\n\n## Checking VTEX gift card details\n\nWhen you want to check details about a specific gift card, you can use the [Get GiftCard by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23get-/giftcards/-giftCardID-) endpoint. In this request, you must send the gift card identification (`giftCardId`) as a path parameter.\n\nSee an example below using gift card `92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74`:\n\n**GET**\n\n`https://{accountName}.{environment}.com.br/api/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74\", \n\n3\n\n \"redemptionToken\": \"COCW-OZYZ-BEXN-TIMU\", \n\n4\n\n \"redemptionCode\": \"COCW-OZYZ-BEXN-TIMU\", \n\n5\n\n \"balance\": 0.0, \n\n6\n\n \"relationName\": \"loyalty-program-test\", \n\n7\n\n \"emissionDate\": \"2023-08-23T16:20:01.047\", \n\n8\n\n \"expiringDate\": \"2024-01-01T00:00:00\", \n\n9\n\n \"caption\": \"Vtex Loyal Test\", \n\n10\n\n \"currencyCode\": \"BRL\", \n\n11\n\n \"discount\": false, \n\n12\n\n \"transaction\": { \n\n13\n\n \"href\": \"/cosmetics2/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions\" \n\n14\n\n } \n\n15\n\n} \n\n`\n\n> You can also check the information of a VTEX gift card using the VTEX Admin. For more information, go to **Promotions > Gift Cards > Search or Filter Results**.\n\n## Creating VTEX gift card transactions\n\nA gift card transaction is a record of an operation that changes the gift card balance, such as a purchase or a refund. To change balance values, you can use the [Create GiftCard Transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23post-/giftcards/-giftCardID-/transactions) endpoint.\n\nThe sections below show a simulation of how to make the following changes to a gift card balance:\n\n* Add 500 USD\n* Spend 120 USD\n\n### Adding balance to a gift card\n\nYou can use the [Create GiftCard Transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23post-/giftcards/-giftCardID-/transactions) endpoint to add balance to a gift card. In this request, you must send the gift card identification (`giftCardId`) as a path parameter.\n\nSee an example below using gift card `92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74`.\n\n**POST**\n\n`https://{accountName}.{environment}.com.br/api/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions`\n\nTo indicate that you wish to add 500 USD to your balance, send \"Credit\" in the \"operation\" field and 500 in the \"value\" field.\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"operation\": \"Credit\", \n\n3\n\n \"value\": 500, \n\n4\n\n \"description\": \"Opening balance\", \n\n5\n\n \"redemptionToken\": \"COCW-OZYZ-BEXN-TIMU\", \n\n6\n\n \"redemptionCode\": \"COCW-OZYZ-BEXN-TIMU\", \n\n7\n\n \"requestId\": \"1\" \n\n8\n\n} \n\n`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"cardId\": \"74\", \n\n3\n\n \"id\": \"465f2d7370f349879f4c194ac81d8e98\", \n\n4\n\n \"_self\": { \n\n5\n\n \"href\": \"cosmetics2/giftcards/74/transactions/465f2d7370f349879f4c194ac81d8e98\" \n\n6\n\n } \n\n7\n\n} \n\n`\n\nTo confirm the new gift card balance, use the [Get GiftCard by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23get-/giftcards/-giftCardID-) endpoint or the Admin dashboard.\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74\", \n\n3\n\n \"redemptionToken\": \"COCW-OZYZ-BEXN-TIMU\", \n\n4\n\n \"redemptionCode\": \"COCW-OZYZ-BEXN-TIMU\", \n\n5\n\n \"balance\": 500.0000, \n\n6\n\n \"relationName\": \"loyalty-program-test\", \n\n7\n\n \"emissionDate\": \"2023-08-23T16:20:01.047\", \n\n8\n\n \"expiringDate\": \"2024-01-01T00:00:00\", \n\n9\n\n \"caption\": \"Vtex Loyal Test\", \n\n10\n\n \"currencyCode\": \"BRL\", \n\n11\n\n \"discount\": false, \n\n12\n\n \"transaction\": { \n\n13\n\n \"href\": \"/cosmetics2/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions\" \n\n14\n\n } \n\n15\n\n} \n\n`\n\nAdmin\n\n\n\n### Removing balance from a gift card\n\nTo remove balance from a gift card, you must also use the [Create GiftCard Transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23post-/giftcards/-giftCardID-/transactions) endpoint and send the gift card identification (`giftCardId`) as a path parameter.\n\nSee an example below using gift card `92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74`.\n\n**POST**\n\n`https://{accountName}.{environment}.com.br/api/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions`\n\nTo indicate that you wish to remove 120 USD from your balance, send the information \"Debit\" in the \"operation\" field and 120 in the \"value\" field.\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"operation\": \"Debit\", \n\n3\n\n \"value\": 120, \n\n4\n\n \"description\": \"Payment of order 5555\", \n\n5\n\n \"redemptionToken\": \"COCW-OZYZ-BEXN-TIMU\", \n\n6\n\n \"redemptionCode\": \"COCW-OZYZ-BEXN-TIMU\", \n\n7\n\n \"requestId\": \"2\" \n\n8\n\n} \n\n`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"cardId\": \"74\", \n\n3\n\n \"id\": \"c2b69a5990404a11b26888964bed3868\", \n\n4\n\n \"_self\": { \n\n5\n\n \"href\": \"cosmetics2/giftcards/74/transactions/c2b69a5990404a11b26888964bed3868\" \n\n6\n\n } \n\n7\n\n} \n\n`\n\n> Whenever you create a new transaction, you must send a `requestId` different from the ones previously used for that gift card. Transactions that have a `requestId` value previously used on the same gift card will not be completed. Example: After creating the first credit transaction, in which you used the value \"1\" for `requestId`, you create a debit transaction with `requestId` equal to \"2\". Any other transaction for this gift card must be created with values different from \"1\" and \"2\" in the `requestId`.\n\nTo confirm the new gift card balance, use the Get GiftCard by ID endpoint or Admin dashboard.\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74\", \n\n3\n\n \"redemptionToken\": \"COCW-OZYZ-BEXN-TIMU\", \n\n4\n\n \"redemptionCode\": \"COCW-OZYZ-BEXN-TIMU\", \n\n5\n\n \"balance\": 380.0000, \n\n6\n\n \"relationName\": \"loyalty-program-test\", \n\n7\n\n \"emissionDate\": \"2023-08-23T16:20:01.047\", \n\n8\n\n \"expiringDate\": \"2024-01-01T00:00:00\", \n\n9\n\n \"caption\": \"Vtex Loyal Test\", \n\n10\n\n \"currencyCode\": \"BRL\", \n\n11\n\n \"discount\": false, \n\n12\n\n \"transaction\": { \n\n13\n\n \"href\": \"/cosmetics2/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions\" \n\n14\n\n } \n\n15\n\n} \n\n`\n\nAdmin\n\n\n\n## Checking VTEX gift card transactions\n\nYou can use the [List All GiftCard Transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23get-/giftcards/-giftCardID-/transactions) endpoint to check all transactions performed on a gift card. In this request, you must send the gift card identification (`giftCardId`) as a path parameter.\n\nSee an example below using gift card `92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74`.\n\n**GET**\n\n`https://{accountName}.{environment}.com.br/api/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions`\n\nResponse body showing information from two transactions:\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"cardId\": \"92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74\", \n\n4\n\n \"id\": \"c2b69a5990404a11b26888964bed3868\", \n\n5\n\n \"_self\": { \n\n6\n\n \"href\": \"cosmetics2/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions/c2b69a5990404a11b26888964bed3868\" \n\n7\n\n } \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"cardId\": \"92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74\", \n\n11\n\n \"id\": \"465f2d7370f349879f4c194ac81d8e98\", \n\n12\n\n \"_self\": { \n\n13\n\n \"href\": \"cosmetics2/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions/465f2d7370f349879f4c194ac81d8e98\" \n\n14\n\n } \n\n15\n\n } \n\n16\n\n] \n\n`\n\n> If you use this endpoint to request details for a new gift card (which does not yet contain transactions), the response body will be empty.\n\n### Accessing information from a gift card transaction\n\nTo get information about a specific gift card transaction, you can use the [Get GiftCard Transaction by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23get-/giftcards/-giftCardID-/transactions/-transactionID-) endpoint. In this request, you must send the gift card identification (`giftCardId`) and transaction operation (`transactionId`) identification as path parameters.\n\n> The `transactionID` value used in this request is the same id value obtained from the response body of the [List All GiftCard Transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23get-/giftcards/-giftCardID-/transactions) endpoint. For more information, see the [Checking VTEX gift card transactions](#checking-vtex-gift-card-transactions) section.\n\nSee an example below using gift card `92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74` and transaction operation `18f71495d720497cb77dfc521f75087`.\n\n**GET**\n\n`https://{accountName}.{environment}.com.br/api/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_73/transactions/18f71495d720497cb77dfc521f750877`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"value\": 58.0, \n\n3\n\n \"description\": \"Add 58 BRL\", \n\n4\n\n \"date\": \"2023-08-22T22:16:23.2974622Z\", \n\n5\n\n \"requestId\": \"10\", \n\n6\n\n \"settlement\": { \n\n7\n\n \"href\": \"/cosmetics2/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_73/transactions/18f71495d720497cb77dfc521f750877/settlements\" \n\n8\n\n }, \n\n9\n\n \"cancellation\": { \n\n10\n\n \"href\": \"/cosmetics2/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_73/transactions/18f71495d720497cb77dfc521f750877/cancellations\" \n\n11\n\n }, \n\n12\n\n \"authorization\": { \n\n13\n\n \"href\": \"/cosmetics2/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_73/transactions/18f71495d720497cb77dfc521f750877/authorization\" \n\n14\n\n }, \n\n15\n\n \"operation\": \"Credit\" \n\n16\n\n} \n\n`\n\n## Cancelling a VTEX gift card transaction\n\nTo partially or completely cancel a value assigned in a transaction (credit or debit), you can use the [Cancel GiftCard Transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23post-/giftcards/-giftCardID-/transactions/-transactionID-/cancellations) endpoint. In this request, you must send the gift card identification (`giftCardId`) and transaction operation (`transactionId`) identification as path parameters.\n\n> The transactionId value used in this request is the same id value obtained from the response body of the List All GiftCard Transactions endpoint. For more information, see the Checking VTEX gift card transactions section.\n\nThe example below shows how to partially cancel a debit transaction (`c2b69a5990404a11b26888964bed3868`). The transaction value is 120 USD and the canceled amount will be 20 USD. The gift card used is `92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74` (current balance of 380 USD).\n\n**POST**\n\n`https://{accountName}.{environment}.com.br/api/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions/c2b69a5990404a11b26888964bed3868/cancellations`\n\nTo indicate that you want to cancel the amount of 20 USD in the debit transaction, send 20 in the \"value\" field.\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"value\": 20, \n\n3\n\n \"requestId\": \"4\" \n\n4\n\n} \n\n`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"oid\": \"a1e7edfb72d74bfa960cdbc2eb9471ce\", \n\n3\n\n \"value\": 20.0, \n\n4\n\n \"date\": \"2023-08-23T17:28:39.7212872Z\" \n\n5\n\n} \n\n`\n\nTo confirm the new gift card balance, use the [Get GiftCard by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23get-/giftcards/-giftCardID-) endpoint or the Admin dashboard.\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74\", \n\n3\n\n \"redemptionToken\": \"COCW-OZYZ-BEXN-TIMU\", \n\n4\n\n \"redemptionCode\": \"COCW-OZYZ-BEXN-TIMU\", \n\n5\n\n \"balance\": 400.0000, \n\n6\n\n \"relationName\": \"loyalty-program-test\", \n\n7\n\n \"emissionDate\": \"2023-08-23T16:20:01.047\", \n\n8\n\n \"expiringDate\": \"2024-01-01T00:00:00\", \n\n9\n\n \"caption\": \"Vtex Loyal Test\", \n\n10\n\n \"currencyCode\": \"BRL\", \n\n11\n\n \"discount\": false, \n\n12\n\n \"transaction\": { \n\n13\n\n \"href\": \"/cosmetics2/giftcards/92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff_74/transactions\" \n\n14\n\n } \n\n15\n\n} \n\n`\n\nAdmin\n\n\n\n> When a debit transaction is canceled, the canceled amount is credited to the total gift card balance. Likewise, when a credit transaction is canceled, the canceled amount is debited from the total gift card balance.\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/gift-card-integration-guide/managing-vtex-gift-cards.md)\n\n[Gift Card system architecture« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards//docs/guides/gift-card-integration-guide-system-architecture)[Headless commerceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards//docs/guides/headless-commerce)\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Creating a VTEX gift card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23creating-a-vtex-gift-card)\n\n[Checking VTEX gift card details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23checking-vtex-gift-card-details)\n\n[Creating VTEX gift card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23creating-vtex-gift-card-transactions)\n\n[Adding balance to a gift card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23adding-balance-to-a-gift-card)[Removing balance from a gift card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23removing-balance-from-a-gift-card)\n\n[Checking VTEX gift card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23checking-vtex-gift-card-transactions)\n\n[Accessing information from a gift card transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23accessing-information-from-a-gift-card-transaction)\n\n[Cancelling a VTEX gift card transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23cancelling-a-vtex-gift-card-transaction)\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/gift-card-integration-guide/managing-vtex-gift-cards.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Creating a VTEX gift card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23creating-a-vtex-gift-card)\n\n[Checking VTEX gift card details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23checking-vtex-gift-card-details)\n\n[Creating VTEX gift card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23creating-vtex-gift-card-transactions)\n\n[Adding balance to a gift card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23adding-balance-to-a-gift-card)[Removing balance from a gift card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23removing-balance-from-a-gift-card)\n\n[Checking VTEX gift card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23checking-vtex-gift-card-transactions)\n\n[Accessing information from a gift card transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23accessing-information-from-a-gift-card-transaction)\n\n[Cancelling a VTEX gift card transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards/docs/guides/managing-vtex-gift-cards%23cancelling-a-vtex-gift-card-transaction)\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_6e5e9d2c
|
[
{
"role": "system",
"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 css handles for store customization in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/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-css-handles-for-store-customization/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/docs/guides/store-framework-styling)\n\n[Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\n\n[Contributing with new CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\n\n[Customizing your store's icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-customizing-your-stores-icons)\n\n[Customizing your store’s typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-customizing-your-stores-typography)\n\n[Interactively inspecting storefront blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)\n\n[Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/docs/guides/store-framework-styling)\n\n[Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\n\n[Contributing with new CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\n\n[Customizing your store's icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-customizing-your-stores-icons)\n\n[Customizing your store’s typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-customizing-your-stores-typography)\n\n[Interactively inspecting storefront blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)\n\n[Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/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-css-handles-for-store-customization/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/store-framework)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/store-framework-styling)\n\n[Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\n\nUsing CSS handles for store customizations\n\nLearn how to customize your storefront using CSS handles.\n\nIn this guide, you'll learn how to customize your storefront using CSS handles. These unique identifiers assigned to HTML elements allow you to target and add CSS classes to a component within your [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme).\n\nCSS handles can overwrite a storefront's default styles, allowing for independent customization of specific blocks within a Store Theme. For example, consider you want to customize the `menu-item` blocks of the [Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu) component. You can apply a [general customization](#applying-a-general-customization) or [customize a single block](#customizing-a-single-block).\n\n## Instructions\n\n### Identifying CSS handles\n\n1. Open your browser and go to your store's development workspace using this URL: `https://{workspace}--{account}.myvtex.com?__inspect`. Replace the values inside curly braces with your specific workspace and account names.\n\n> Always use a development workspace and make sure your store domain is under `myvtex.com`.\n\n1. Hover your mouse over the page element you want to customize. A box will appear displaying its available CSS handles (names starting with `.`), CSS file names, and related information.\n\n\n\n1. Check the CSS handles table in the documentation of the app or block that renders the HTML element. This allows you to confirm whether the inspected handle is valid and if the customization requires another add-on, such as the HTML element attribute.\n\n> If a handle requires an HTML element attribute for customization, inspect the page again using your browser's developer tools instead of the `?__inspect` option. Find the desired HTML element and copy its associated attribute for the upcoming customization.\n\n### Applying a general customization\n\nFollow the steps below to apply a style that affects every block instance:\n\n1. Open your Store Theme code using the code editor of your choice and go to the `css` folder.\n2. In the `css` folder, create a new CSS file named after the component you're targeting. For example, `vtex.menu.css`.\n3. In the new file, use one of the listed CSS handles and customize its properties. For example:\n\n`1\n\n.menuItem { \n\n2\n\n background: rgba(0, 0, 0, 0.2); \n\n3\n\n margin: 5px; \n\n4\n\n border-radius: 5px; \n\n5\n\n} \n\n`\n\n> If the handle requires an add-on, such as the HTML element attribute or a handle modifier, add it next to the handle name, following this format: `{cssHandleName}--{addon)`.\n\n1. [Link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) to see the changes. Once linked, the new style applies to all `menu-item` blocks in the workspace you're working on.\n\n\n\n### Customizing a single block\n\nTo customize a single, specific block without affecting others of the same type, use the `blockClass` property, which serves as the block's unique identifier for customization:\n\n1. In the `json` file where your target block is declared, add the prop `blockClass` to the element you want to customize. Assign any unique name as its value. For example:\n\n`1\n\n\"menu-item#your-item\": { \n\n2\n\n \"props\": { \n\n3\n\n ..., \n\n4\n\n \"blockClass\": \"header\" \n\n5\n\n }, \n\n6\n\n ... \n\n7\n\n} \n\n`\n\n1. Save the file to update the workspace you're working on.\n2. Inspect the element by following the instructions in [Identifying CSS handles](#identifying-css-handles). You'll see a new, more specific CSS handle composed of the original handle and the `blockClass` value you provided.\n\n\n\n1. In your CSS file, you can now use this new class (for example: `.menu-Item--header`) to target only the block with that specific `blockClass`.\n\n\n\n## Best practices\n\nCSS selectors are commonly used for customization, but this depends on the HTML structure. If you change the HTML, it can affect your customizations. To standardize CSS customization and avoid any potential breakdown in the layout, we recommend only using CSS handles for store customizations.\n\nCustomization using CSS selectors is mostly deprecated. The following selectors are the only ones allowed for store customization:\n\n* Class selectors (example: `.foo`)\n* Pseudo-selectors `:hover`, `:visited`, `:active`, `:disabled`, `:focus`, `:local`, `:empty`, and `:target`\n* `:not()`\n* `:first-child` and `:last-child`\n* `:nth-child(even)`, `:nth-child(odd)`, and `:nth-child(2n)` (or any other step like `4n`, `5n`, and so on.)\n* All pseudo-elements, such as `::before`, `::after`, and `::placeholder`\n* Space combinator (example: `.foo .bar`)\n* `[data-...]`\n* `:global(vtex-{AppName}-{AppVersion}-{ComponentName})` for selecting elements that come from different apps\n* Media queries, such as `@media (max-width: 768px)` (responsive override for screens up to 768px wide) and `@media (prefers-reduced-motion: reduce)` (remove transitions if user prefers reduced motion).\n\n> CSS selectors that are not included in this list, such as `:nth-child(2)`, `foo > bar`, and `[alt=\"bar\"]`, aren't supported. Using them can cause issues like app linking failure.\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/styling-your-store/vtex-io-documentation-using-css-handles-for-store-customization.md)\n\n[Styling« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization//docs/guides/store-framework-styling)[Contributing with new CSS HandlesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization//docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\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-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23instructions)\n\n[Identifying CSS handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23identifying-css-handles)[Applying a general customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23applying-a-general-customization)[Customizing a single block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23customizing-a-single-block)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23best-practices)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/styling-your-store/vtex-io-documentation-using-css-handles-for-store-customization.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-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23instructions)\n\n[Identifying CSS handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23identifying-css-handles)[Applying a general customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23applying-a-general-customization)[Customizing a single block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23customizing-a-single-block)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23best-practices)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b2a6aac3
|
[
{
"role": "system",
"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 locale switcher 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-locale-switcher/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-locale-switcher/docs/api-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-locale-switcher/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-locale-switcher/docs/storefront-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-locale-switcher/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-locale-switcher/docs/troubleshooting)\n\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-locale-switcher/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-locale-switcher/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-locale-switcher/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-locale-switcher/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-locale-switcher/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-locale-switcher/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-locale-switcher/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-locale-switcher/updates/release-notes)\n\nLocale Switcher\n\nThe Locale Switcher app provides a component capable of changing the current language of your store.\n\n\n\n## Configuration\n\n1. Add the Locale Switcher app to your theme's dependencies in the `manifest.json` file:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.locale-switcher\": \"0.x\" \n\n3\n\n } \n\n`\n\n1. Add the `locale-switcher` block to your header. For example:\n\n`1\n\n\"header-row#desktop\": { \n\n2\n\n \"children\": [ \n\n3\n\n // (...) \n\n4\n\n \"locale-switcher\", \n\n5\n\n \"login\", \n\n6\n\n \"minicart.v2\" \n\n7\n\n ] \n\n8\n\n}, \n\n`\n\n1. Open a ticket to our support team in order to adjust your store's binding with the desired languages.\n\n> **\\*Caution:** The third step is mandatory. If no ticket is opened requiring the desired languages, the selection list may not appear on the Locale Switcher component.\\*\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ----------------- |\n| button |\n| buttonText |\n| container |\n| list |\n| listElement |\n| localeIdText |\n| relativeContainer |\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-locale-switcher.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-locale-switcher/docs/guides/vtex-locale-switcher%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-locale-switcher/docs/guides/vtex-locale-switcher%23customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-locale-switcher.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-locale-switcher/docs/guides/vtex-locale-switcher%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-locale-switcher/docs/guides/vtex-locale-switcher%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_94fd0d76
|
[
{
"role": "system",
"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 searchbar 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/SearchBar/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/SearchBar/docs/api-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/SearchBar/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/SearchBar/docs/storefront-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/SearchBar/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/SearchBar/docs/troubleshooting)\n\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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SearchBar/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SearchBar/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SearchBar/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SearchBar/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SearchBar/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/docs/vtex-io-apps)\n\nSearch Bar\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 `search-bar` component shows a search bar with autocomplete options and displays the matching products as well. 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 `search-bar` block into the [header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-header) component. For example:\n\n`1\n\n \"header.full\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"login\", \n\n4\n\n \"minicart\", \n\n5\n\n \"logo\", \n\n6\n\n+ \"search-bar\", \n\n7\n\n \"menu-link\", \n\n8\n\n \"telemarketing\", \n\n9\n\n \"category-menu\" \n\n10\n\n ] \n\n11\n\n }, \n\n`\n\n1. Then, declare the `search-bar` block using the props stated in the [Props](#props) table. For example:\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ----------------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| attemptPageTypeSearch | Boolean | If true when clicked on result link of brand, department or category will link to the corresponding brand, department or category page. When false will always go to a full text search page. | false |\n| autocompleteAlignment | [HorizontalAlignment](#horizontalalignment) | Autocomplete Horizontal alignment. Possible values are: left, center, right. | left |\n| autocompleteFullWidth | Boolean | If true, the autocomplete will fill the whole window horizontally. | false |\n| autoFocus | Boolean | Define if the search input should autofocus or not | \\- |\n| blurOnSubmit | Boolean | Define if input should blur on submit. | false |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n| containerMode | enum | Defines how the autocomplete component should be displayed. Possible values are: overlay (suggestions overlapping other components) and container (displays the suggestion within a container). | overlay |\n| compactMode | Boolean | Define when to use the compact version of the component | \\- |\n| customSearchPageUrl | string | Template for a custom url. It can have a substring ${term} used as placeholder to interpolate the searched term. (e.g. /search?query=${term}) | \\- |\n| disableBlurAndTouchEndHandler | Boolean | The autocomplete can have touchable/clickable components. Interacting with those components may trigger blur and touch events that will close the autocomplete. When set to true, this prop will disable those handlers. | false |\n| displayMode | [DisplayMode](#displaymode) | Define the component display mode, such as which buttons should be visible. | clear-button |\n| emptyPlaceholder | String! | Shows a placeholder when the ResultList hasn't results to displayed | \\- |\n| hasIconLeft | Boolean | Define if the search icon is on left or right position | \\- |\n| iconClasses | String |  Custom classes for the search icon. Use the CSS handle searchBarIcon. | \\- |\n| inputType | enum | Defines the value for the type HTML attribute (from the <input> field). Possible values are: search and text. We strongly recommend you to use search as it fixes some iOS issues. The text value is only kept as default for backwards compatibility. | text |\n| maxWidth | Number \\| String | Max width of the search bar | \\- |\n| minSearchTermLength | Number | If defined, it will block searches where the term length is lesser than minSearchTermLength. | \\- |\n| openAutocompleteOnFocus | Boolean | Defines if autocomplete should be open on input focus or not. | false |\n| placeholder | String! | Placeholder to be used on the input | \\- |\n| submitOnIconClick | Boolean |  Defines if search icon should submit on click. Use the displayMode prop instead. | false |\n\n#### `DisplayMode`\n\n| Enum name | Enum value | Empty state | Filled state |\n| ------------------------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| clear-button | 'clear-button' |  |  |\n| search-and-clear-buttons | 'search-and-clear-buttons' |  |  |\n| search-button | 'search-button' |  |  |\n\n## Using SearchBar with Intelligent Search\n\nTo improve the search experience usign the SearchBar component, such as the autocomplete option, you must use the component within [Search app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) responsible for handling the [Intelligent Search (IS)](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search?%5Fga=2.220970832.979717665.1650285782-1001456323.1619912759) solution in IO stores.\n\nThe IS communicates with the `autocomplete-result-list.v2` block exported by the Search app, and the block displays previous search results based on current and previous searches.\n\nFollow the [Search documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) to add the Search app to your store.\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| compactMode |\n| externalSearchButtonWrapper |\n| paddingInput |\n| searchBarContainer |\n| searchBarInnerContainer--opened |\n| searchBarInnerContainer--filled |\n| searchBarIcon |\n| searchBarIcon--clear |\n| searchBarIcon--external-search |\n| searchBarIcon--prefix |\n| searchBarIcon--search |\n| suffixWrapper |\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/SearchBar/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/SearchBar/docs/apps/vtex.store-components/SearchBar%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SearchBar/docs/apps/vtex.store-components/SearchBar%23props)\n\n[Using SearchBar with Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SearchBar/docs/apps/vtex.store-components/SearchBar%23using-searchbar-with-intelligent-search)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SearchBar/docs/apps/vtex.store-components/SearchBar%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_0cf3d3d1
|
[
{
"role": "system",
"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 project structure custom cypress 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/project-structure-custom-cypress/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/api-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/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/storefront-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/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/troubleshooting)\n\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/project-structure-custom-cypress/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/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/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/project-structure-custom-cypress/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/project-structure-custom-cypress/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/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/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/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/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/project-structure-custom-cypress/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/project-structure-custom-cypress/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/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/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/project-structure-custom-cypress/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-overview)\n\nCustom Cypress integration\n\n> This is an experimental feature.\n\nThe `enableCypressExtension` experimental feature flag allows you to leverage [Cypress](https://read.calvincode.net/reader?url=https://www.cypress.io/) extensions within your FastStore project, enabling you to seamlessly run custom Cypress tests.\n\nCypress extensions enhance the testing capabilities of your Faststore project by enabling the incorporation of custom Cypress tests alongside the native integration tests provided by Faststore.\n\nWith `enableCypressExtension`, you can implement custom integration tests into a dedicated Cypress folder within your storefront project. This integration ensures the smooth execution of both the native tests and the custom ones you create as part of the continuous integration (CI) pipeline. Learn how to add custom integration tests in the following steps.\n\n---\n\n## Before you begin\n\n* Please be aware that this feature is experimental and may not be suitable for all use cases.\n* Refer to [Cypress documentation](https://read.calvincode.net/reader?url=https://docs.cypress.io/guides/overview/why-cypress) for more information on this testing tool.\n* Ensure you are using `@faststore/core` `2.1.56` version or above and `@faststore/cli` version `2.2.9` or above. If you have versions lower than these requirements, update them as follows: \n 1. In your storefront project, open the `package.json` file. \n 2. Navigate to the `@faststore/core` and update it to at least `2.1.56`. \n 3. Navigate to the `@faststore/cli` and update it to at least `2.2.9`. \n 4. Run `yarn dev` to apply these changes.\n\n---\n\n## Step 1: Enabling `enableCypressExtension`\n\n1. Open the `discovery.config.js` file.\n2. Add the `experimental` object and set the `enableCypressExtension` value to `true`:\n\ndiscovery.config.js\n\n`1\n\n experimental: { \n\n2\n\n enableCypressExtension: true, \n\n3\n\n } \n\n`\n\n## Step 2: Integrating custom Cypress tests into your FastStore project\n\nLike any other project using Cypress, you'll follow standard practices, including setting up standard Cypress folders and configuration files. This allows you to seamlessly add and execute your custom integration tests within your project. For further details on Cypress configuration, refer to the official [Cypress configuration](https://read.calvincode.net/reader?url=https://docs.cypress.io/guides/references/configuration) guide.\n\n1. In the root directory of your storefront project, create a new folder named `cypress`.\n2. Add your custom integration tests within the `cypress/integration` folder.\n3. With the local server running, run `yarn test` to open the Cypress app and check your test execution.\n4. Open a pull request with the changes you have made.\n5. Within the pull request, navigate to **Checks > Integration Tests** and check the **Details** section.\n\n\n\n1. Review the results to check the execution status of your custom integration tests.\n\n---\n\n## Running only custom Cypress tests in FastStore projects\n\nAs storefront projects evolve, changes to component and page code may lead to errors in the default end-to-end tests conducted for all FastStore projects.\n\nIn such cases, you can override FastStore's default tests using custom tests with the same name as the original test files. For example:\n\nplp.test.js\n\n`1\n\nimport { cypress } from '../../discovery.config' \n\n2\n\n \n3\n\nconst { pages } = cypress \n\n4\n\n \n5\n\ndescribe('Custom PLP tests', () => { \n\n6\n\n it('visit collection page', () => { \n\n7\n\n cy.visit(pages.collection) \n\n8\n\n cy.get('[data-testid=\"product-gallery\"]').should('exist').and('be.visible') \n\n9\n\n }) \n\n10\n\n}) \n\n`\n\n> Although exclusive execution of custom tests is possible for projects using Cypress version 12.x, we do not recommend this approach. If possible, keep the default Cypress tests.\n\nSome projects may prefer exclusive execution of its custom Cypress tests. Although it is not our recommendation, for projects using Cypress version 12.x or higher, there is the possibility of running the **Integration Tests** check only for your custom tests.\n\nFollow the steps below to configure your project to only run custom Cypress tests:\n\n### Instructions\n\n#### Step 1 - Setting Cypress version\n\nFirst, ensure that you use Cypress version 12 by setting the `cypressVersion` experimental feature flag:\n\n1. Open the `discovery.config.js` file.\n2. Inside the `experimental` object, add the `cypressVersion` property.\n3. Set the `cypressVersion` value to `12`.\n\ndiscovery.config.js\n\n`1\n\n experimental: { \n\n2\n\n enableCypressExtension: true, \n\n3\n\n cypressVersion: 12, \n\n4\n\n } \n\n`\n\n#### Step 2 - Updating the Cypress configuration file\n\nEnsure that your Cypress configuration file (`cypress.json`) matches the latest Cypress configuration file format. To do so, refer to the official [Cypress configuration file](https://read.calvincode.net/reader?url=https://docs.cypress.io/guides/references/configuration) guide.\n\n#### Step 3 - Changing the custom Cypress tests directory\n\nNow, change your custom Cypress tests directory from `cypress/integration` to `cypress/e2e`:\n\n1. In your storefront project, rename the folder from `cypress/integration` to `cypress/e2e`.\n2. Update your new Cypress configuration file `cypress.config.ts` to match the new custom tests folder `cypress/e2e` by specifying the `specPattern`:\n\ncypress.config.ts\n\n`1\n\nimport { defineConfig } from 'cypress' \n\n2\n\n \n3\n\nexport default defineConfig({ \n\n4\n\n ..., \n\n5\n\n e2e: { \n\n6\n\n ..., \n\n7\n\n specPattern: 'cypress/e2e/**/*.test.{js,jsx,ts,tsx}', \n\n8\n\n }, \n\n9\n\n}) \n\n`\n\n1. Run `yarn dev` in the terminal to sync the changes you have made.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/custom-cypress.mdx)\n\n[Configuration options for discovery.config.js« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-config-options)[FastStore CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-faststore-cli)\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/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23before-you-begin)\n\n[Step 1: Enabling enableCypressExtension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23step-1-enabling-enablecypressextension)\n\n[Step 2: Integrating custom Cypress tests into your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23step-2-integrating-custom-cypress-tests-into-your-faststore-project)\n\n[Running only custom Cypress tests in FastStore projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23running-only-custom-cypress-tests-in-faststore-projects)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%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/developer-tools/custom-cypress.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/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23before-you-begin)\n\n[Step 1: Enabling enableCypressExtension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23step-1-enabling-enablecypressextension)\n\n[Step 2: Integrating custom Cypress tests into your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23step-2-integrating-custom-cypress-tests-into-your-faststore-project)\n\n[Running only custom Cypress tests in FastStore projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23running-only-custom-cypress-tests-in-faststore-projects)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%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_a4d306db
|
[
{
"role": "system",
"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 promoting a workspace to master 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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/docs/api-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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/docs/storefront-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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/docs/troubleshooting)\n\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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n[Releasing a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-releasing-a-new-app-version)\n\n[Publishing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-publishing-an-app)\n\n[Deploying the app's stable version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-deploying-the-app-stable-version)\n\n[Promoting a workspace to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n[Releasing a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-releasing-a-new-app-version)\n\n[Publishing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-publishing-an-app)\n\n[Deploying the app's stable version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-deploying-the-app-stable-version)\n\n[Promoting a workspace to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/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-promoting-a-workspace-to-master/docs/app-development)\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n[Promoting a workspace to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)\n\nPromoting a workspace to Master\n\nPromoting a production workspace to Master is the final step in [making an app publicly available to end users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available). After launching your app as a stable version and thoroughly testing it in a production workspace, you can promote your workspace to Master to make your new app version publicly available to end users.\n\nNote that once promoted to Master, you can't make new code changes in your app version. Alternatively, you would need to develop your code in a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/) and reproduce it in a new production workspace, so you could test your changes with user traffic before making your new changes publicly available.\n\n\n\n## Before you begin\n\nBefore proceeding any further, make sure your app has been [published](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) in the workspace you are about to promote.\n\nRemember that, when you promote a workspace to master, your changes are applied to all workspaces of the current account. Hence, if you are promoting a new version of the [Store Theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme) to master, make sure to complete all the necessary adjustments to store content in Site Editor and to your code beforehand. Furthermore, the apps installed in the promoted workspace will be installed in all the other workspaces, which is described on [Workspace behavior with app installations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations).\n\nPromoting a workspace to Master is a step in **making your new app version publicly available**. Please check [this](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available) guide for more information.\n\n## Instructions\n\nFollow these steps to promote a production workspace to Master. Remember to replace the values between curly brackets according to your scenario.\n\n1. Open the terminal and log in to your VTEX account. \n`1 \nvtex login {accountName} \n`\n2. Change to the production workspace to be promoted. \n`1 \nvtex use {workspaceName} \n`\n3. Promote the workspace being used. \n`1 \nvtex workspace promote \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/App-Guides/vtex-io-documentation-making-your-new-app-version-publicly-available/vtex-io-documentation-promoting-a-workspace-to-master.md)\n\n[Deploying the app's stable version« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master//docs/guides/vtex-io-documentation-deploying-the-app-stable-version)[VTEX App StoreNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master//docs/guides/vtex-app-store)\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-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master%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/vtex-io-documentation-making-your-new-app-version-publicly-available/vtex-io-documentation-promoting-a-workspace-to-master.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-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master%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_c0e4645a
|
[
{
"role": "system",
"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 drawer 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-drawer/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-drawer/docs/api-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-drawer/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-drawer/docs/storefront-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-drawer/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-drawer/docs/troubleshooting)\n\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-drawer/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/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/guides/vtex-store-drawer/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/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/guides/vtex-store-drawer/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/guides/advanced-components)\n\nDrawer\n\nOfficial extension\n\nVersion: 0.18.3\n\nLatest version: 0.18.3\n\n[](#contributors-)\n\nThe **Drawer** component is a sliding panel that displays additional options and menus when expanded. It is typically used in mobile layouts and responsive web designs where screen space is limited.\n\n\n\nWhen closed, the **Drawer** component is represented by an icon button positioned at the edge of the screen. Upon interaction, the drawer slides into view, revealing its content. Users can interact with the exposed content, perform actions, and navigate menus. To dismiss the drawer, users can either tap outside the drawer or use the close button.\n\n## Configuration\n\n1. Open your store theme in the code editor of your preference.\n2. Open the `manifest.json` file and add the `vtex.store-drawer` app to your store theme dependencies as in the following:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.store-drawer\": \"0.x\" \n\n3\n\n} \n\n`\n\n1. Add the `drawer` block to your app. The following example is from the [Store Theme](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme).\n\n`1\n\n\"drawer\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"menu#drawer\" \n\n4\n\n ] \n\n5\n\n}, \n\n6\n\n \n7\n\n\"menu#drawer\": { \n\n8\n\n \"children\": [ \n\n9\n\n \"menu-item#category-clothing\", \n\n10\n\n \"menu-item#category-decoration\", \n\n11\n\n \"menu-item#custom-sale\" \n\n12\n\n ], \n\n13\n\n \"props\": { \n\n14\n\n \"orientation\": \"vertical\" \n\n15\n\n } \n\n16\n\n}, \n\n`\n\n1. Use the `drawer-trigger` block to customize the icon that triggers the opening of the drawer as follows:\n\n`1\n\n\"drawer\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"menu#drawer\" \n\n4\n\n ], \n\n5\n\n \"blocks\": [\"drawer-trigger\"] \n\n6\n\n}, \n\n7\n\n \n8\n\n\"drawer-trigger\": { \n\n9\n\n \"children\": [\"rich-text#open-drawer\"] \n\n10\n\n}, \n\n11\n\n \n12\n\n\"rich-text#open-drawer\": { \n\n13\n\n \"props\": { \n\n14\n\n \"text\": \"Open drawer\" \n\n15\n\n } \n\n16\n\n} \n\n17\n\n \n18\n\n\"menu#drawer\": { \n\n19\n\n \"children\": [ \n\n20\n\n \"menu-item#category-clothing\", \n\n21\n\n \"menu-item#category-decoration\", \n\n22\n\n \"menu-item#custom-sale\" \n\n23\n\n ], \n\n24\n\n \"props\": { \n\n25\n\n \"orientation\": \"vertical\" \n\n26\n\n } \n\n27\n\n}, \n\n`\n\n1. Use the `drawer-header` block to customize the header containing the button that closes the drawer. For example:\n\n`` 1\n\n// blocks.json \n\n2\n\n{ \n\n3\n\n \"drawer\": { \n\n4\n\n \"blocks\": [\"drawer-header#my-drawer\"] \n\n5\n\n }, \n\n6\n\n \"drawer-header#my-drawer\": { \n\n7\n\n \"children\": [ \n\n8\n\n // you need to include the block `drawer-close-button` somewhere inside here \n\n9\n\n \"flex-layout.row#something\", \n\n10\n\n // ... \n\n11\n\n \"drawer-close-button\" \n\n12\n\n ] \n\n13\n\n } \n\n14\n\n} \n\n ``\n\n### Using the Drawer as a standalone component\n\nIf you are using this component as a standalone module, you will need to import it into the specific component where you want to use it. For example:\n\n`1\n\nimport { Drawer, DrawerHeader, DrawerCloseButton } from \"vtex.store-drawer\"; \n\n2\n\n \n3\n\nconst Menu = () => ( \n\n4\n\n <Drawer \n\n5\n\n header={ \n\n6\n\n <DrawerHeader> \n\n7\n\n <DrawerCloseButton /> \n\n8\n\n </DrawerHeader> \n\n9\n\n } \n\n10\n\n > \n\n11\n\n <ul> \n\n12\n\n <li>Link 1</li> \n\n13\n\n <li>Link 2</li> \n\n14\n\n <li>Link 3</li> \n\n15\n\n <li>Link 4</li> \n\n16\n\n <li>Link 5</li> \n\n17\n\n <li>Link 6</li> \n\n18\n\n </ul> \n\n19\n\n </Drawer> \n\n20\n\n); \n\n`\n\n### Props\n\n#### `drawer`\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| maxWidth | number or string | Defines the maximum width of the open drawer. | 450 |\n| isFullWidth | boolean | Controls whether the open drawer should occupy the full available width. | false |\n| slideDirection | 'horizontal'\\|'vertical'|'rightToLeft'|'leftToRight' | Controls the direction of the opening animation for the drawer. | 'horizontal' |\n| backdropMode | 'default'\\|'none' | Controls whether the backdrop should be displayed when the drawer is open. | |\n| renderingStrategy | 'lazy'\\|'eager' | Controls the rendering strategy for the children of the drawer component. It determines whether the children should be rendered only when the drawer is clicked (lazy) or immediately when the page loads (eager). Enabling the eager strategy may improve SEO performance. However, it may also result in slower page rendering. | 'lazy' |\n| customPixelEventId | string | Defines the store event ID responsible for triggering the drawer to automatically open on the interface. | undefined |\n| customPixelEventName | string | Defines the store event name responsible for triggering the drawer to automatically open on the interface. Some examples are: 'addToCart' and 'removeFromCart' events. Note that if no customPixelEventId is set, using this prop will cause the drawer to open in every event with the specified name. | undefined |\n\n#### `drawer-close-button`\n\n| Prop name | Type | Description | Default value |\n| --------- | ---------------- | ------------------------------------------------------------------------------------- | ------------- |\n| size | number | Defines the size of the icon inside the button. | 30 |\n| type | 'filled'\\|'line' | Defines the type of the icon. | 'line' |\n| text | string | Defines the text inside the button. The icon will not be rendered if text is defined. | undefined |\n\n#### `drawer-trigger`\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ------ | ---------------------------------------------------------------------------------- | ------------- |\n| customPixelEventId | string | Defines the event ID to be sent whenever users interact with the Drawer component. | undefined |\n\n## Customization\n\nIn order to apply CSS customizations to this and other blocks, follow the instructions in [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| drawer |\n| opened |\n| overlay |\n| overlay--visible |\n| closed |\n| moving |\n| drawerContent |\n| drawerHeader |\n| drawerTriggerContainer |\n| openIconContainer |\n| closeIconContainer |\n| closeIconButton |\n| childrenContainer |\n\n[Similar Products Variants« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.similar-products-variants)[Store LocatorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-locator)\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-store-drawer/docs/apps/vtex.store-drawer%23configuration)\n\n[Using the Drawer as a standalone component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-drawer%23using-the-drawer-as-a-standalone-component)[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-drawer%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer/docs/apps/vtex.store-drawer%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_354ae4db
|
[
{
"role": "system",
"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 search provider specification 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-search-provider-specification/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/api-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-search-provider-specification/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-search-provider-specification/docs/storefront-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-search-provider-specification/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-search-provider-specification/docs/troubleshooting)\n\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-search-provider-specification/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/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-search-provider-specification/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/search-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-recipe)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-reference)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/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-search-provider-specification/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/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-search-provider-specification/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-search-provider-specification/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/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-search-provider-specification/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/search-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-recipe)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-reference)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/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-search-provider-specification/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/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-search-provider-specification/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-search-provider-specification/docs/guides)\n\nIntegration Guides\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/search-integration-guide)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification)\n\nSpecification\n\n## GraphQL Queries to Implement\n\nTo implement the protocol you need to implement resolvers for every GraphQL query on the `vtex.search-graphql` [schema](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-graphql). As explained in the Limitations section below, only a part of these queries are actually interesting for an external search provider to implement:\n\n* `productSearch`: the actual search engine query\n* `facets`: facets to be used as filters\n* `banners`: banners to retrieve and show in specific sections of the web page\n* `correction`: Corrections for possible typos that a user makes when searching for a product\n* `searchSuggestions`: Suggestions of terms based on the search term that the user has made.\n* `topSearches`: top searches that is shown when a user puts the cursor over the search bar\n* `autocompleteSearchSuggestions`: suggestions of products and terms to be shown in the search bar.\n* `productSuggestions`: suggestions of products to be shown in the search result page\n* `searchMetadata`: metadata for the specific search result page\n\n## GraphQL Queries Not needed to be Reimplemented\n\nThe following queries are not needed to reimplement using the external search provider, as they don't add anything potentially beneficial to the UX if you use an external search provider. On the other hand, these queries are still needed for the store to work properly, so make sure to leverage the VTEX Catalog API's to implement them.\n\n* `product`\n* `products`\n* `productsByIdentifier`\n* `searchURLsCount`\n\n## Limitations\n\n* It is only possible to have one search-resolver service per workspace. If more than one is installed, the workspace will break. This is a known issue that we plan to solve in the near future. To start the development of a new search provider, create a workspace, uninstall the old one (e.g. `vtex.search-resolver`), and then you can start developing your new `search-resolver`.\n* The 4 queries listed above that are not needed to be reimplemented are still indeed needed to be implemented. So the best path at this moment is to copy the code for these 4 queries from the reference implementations section.\n\n## Indexing\n\n* You can also use the same VTEX IO app responsible for being a search provider to also set up a webhook and receive notifications whenever a change in the catalog occurs. This VTEX IO app can, then, send the catalog changes to the search provider.\n\n\n\nTo receive catalog changes, refer to this [Receiving Catalog Changes on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-catalog-changes-on-vtex-io).\n\n## Onboarding\n\n* When a user installs your search-resolver app, you probably will need an admin panel to set up the app. You can find a working example on `https://github.com/vtex-apps/admin-example`. This admin app can show the indexing progress and also notify the search provider service that a new customer needs to be onboarded.\n* The onboarding flow usually is: VTEX client installs app in a different workspace than master → Enters the admin panel to set up the app → app notifies indexing system that a new account is to be indexed → index is 100% completed → VTEX client can promote/install the search provider in master.\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/search-integration-guide/external-search-provider-specification.md)\n\n[Overview« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification//docs/guides/external-search-provider-overview)[RecipeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification//docs/guides/external-search-provider-recipe)\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[GraphQL Queries to Implement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification%23graphql-queries-to-implement)\n\n[GraphQL Queries Not needed to be Reimplemented](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification%23graphql-queries-not-needed-to-be-reimplemented)\n\n[Limitations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification%23limitations)\n\n[Indexing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification%23indexing)\n\n[Onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification%23onboarding)\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/search-integration-guide/external-search-provider-specification.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[GraphQL Queries to Implement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification%23graphql-queries-to-implement)\n\n[GraphQL Queries Not needed to be Reimplemented](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification%23graphql-queries-not-needed-to-be-reimplemented)\n\n[Limitations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification%23limitations)\n\n[Indexing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification%23indexing)\n\n[Onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-specification/docs/guides/external-search-provider-specification%23onboarding)\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_214e776f
|
[
{
"role": "system",
"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 1.63.0 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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/rewriter-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/rewriter-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/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@1.63.0/rewriter-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/rewriter-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/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@1.63.0/rewriter-graphql-api/docs/guides/functional-apps)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/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.63.0\n\nLatest version: 1.68.0\n\n> This page is about version **1.63.0** of the app, which is not the most recent version. The latest stable version is **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@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter)[Responsive ValuesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/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@1.63.0/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@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23schema-description)\n\n[QueryRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23queryredirect)[QueryInternal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23queryinternal)[MutateRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23mutateredirect)[MutateInternal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23mutateinternal)[Internal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23internal)[ListInternalsResponse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23listinternalsresponse)[RoutesByBinding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23routesbybinding)[Redirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23redirect)[ListRedirectsResponse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23listredirectsresponse)[EntityLocator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23entitylocator)[InternalInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23internalinput)[RedirectInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23redirectinput)[RouteLocator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api%23routelocator)[RedirectTypes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter@1.63.0/rewriter-graphql-api/docs/apps/vtex.rewriter@1.63.0/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_72137555
|
[
{
"role": "system",
"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 an auto increment field in master data v2 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\nSetting up an auto increment field in Master Data v2\n\n**Auto increment** is a Master Data feature that automatically creates unique and sequential values to `integer` type fields when new documents are created.\n\n> The starting value of auto increment fields is always `1`. This value can not be changed.\n\n## Set up\n\nAuto increment fields can be set up in data entities' [JSON schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/working-with-json-schemas-in-master-data-v2).\n\nCreate an `integer` field and add its name to the `v-auto-increment` property, like in the example below:\n\n`1\n\n{ \n\n2\n\n \"properties\": { \n\n3\n\n \"valueAsAutoIncrement\": { \n\n4\n\n \"type\": \"integer\" \n\n5\n\n } \n\n6\n\n }, \n\n7\n\n \"v-auto-increment\": [ \n\n8\n\n \"valueAsAutoIncrement\" \n\n9\n\n ] \n\n10\n\n} \n\n`\n\n> \\- The auto-increment field cannot be `required`.\n\n* The field's type has to be `integer`.\n\n## Usage\n\nWhen [saving new documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/createnewdocument) you must identify the corresponding JSON Schema with the query parameter `_schema`. See an example of this:\n\n`1\n\nPOST \n\n2\n\nhttps://{accountName}.{environment}.com.br/api/dataentities/{dataEntityName}/documents?_schema={schemaName} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/setting-up-an-auto-increment-field-in-master-data-v2.md)\n\n[Setting up alternate keys in Master Data v2« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2//docs/guides/setting-up-alternate-keys-in-master-data-v2)[Master Data v1Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2//docs/guides/master-data-v1)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Set up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2%23set-up)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2%23usage)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/setting-up-an-auto-increment-field-in-master-data-v2.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Set up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2%23set-up)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2%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_6ca6c424
|
[
{
"role": "system",
"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 productsummarylist 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/ProductSummaryList/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/ProductSummaryList/docs/api-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/ProductSummaryList/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/ProductSummaryList/docs/storefront-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/ProductSummaryList/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/ProductSummaryList/docs/troubleshooting)\n\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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/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/ProductSummaryList/docs/vtex-io-apps)\n\nProduct Summary 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\nThe Product Summary List app (`list-context.product-list`) is an instance of the `list-context` interface, which provides predefined interfaces used to create content lists, such as a product list.\n\n\n\nTo create a product list, you must use the `list-context.product-list` and `product-summary.shelf` blocks.\n\n## product-list-block\n\nThis block is used to specify the variation of `product-summary` that should be used to create the product list and the `list-context.product-list` you want, as follows:\n\n`1\n\n \"product-summary.shelf#demo1\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"stack-layout#prodsum\", \n\n4\n\n \"product-summary-name\", \n\n5\n\n \"product-rating-inline\", \n\n6\n\n \"product-summary-space\", \n\n7\n\n \"product-summary-price\", \n\n8\n\n \"product-summary-buy-button\" \n\n9\n\n ] \n\n10\n\n }, \n\n11\n\n \"list-context.product-list#demo1\": { \n\n12\n\n \"blocks\": [\"product-summary.shelf#demo1\"], \n\n13\n\n \"children\": [\"slider-layout#demo-products\"] \n\n14\n\n }, \n\n`\n\n`list-context.product-list` also runs the GraphQL query that fetches the product list, allowing it to receive the following props:\n\n| Prop name | Type | Description | Default value |\n| -------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------ |\n| category | string | Category ID of the listed items. For subcategories, use \"/\" (example: \"1/2/3\"). | \\- |\n| specificationFilters | Array({ id: String, value: String }) | Specification filters of the listed items. | \\[\\] |\n| collection | string | Filter by collection. | \\- |\n| orderBy | enum | Sort type of the items. Possible values are: '', OrderByTopSaleDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, OrderByNameDESC. | OrderByTopSaleDESC |\n| hideUnavailableItems | boolean | Hides unavailable items. | false |\n| maxItems | number | Maximum items to be fetched. | 10 |\n| skusFilter | [SkusFilterEnum](#skusfilterenum) | Control SKUs returned for each product in the query. The fewer SKUs that need to be returned, the more efficient your shelf query will be. Possible values are: FIRST\\_AVAILABLE, ALL\\_AVAILABLE, ALL. | \"ALL\\_AVAILABLE\" |\n| installmentCriteria | [InstallmentCriteriaEnum](#installmentcriteriaenum) | Controls the price that will be displayed when the price has different installment options. Possible values are: MAX\\_WITHOUT\\_INTEREST, MAX\\_WITH\\_INTEREST. | \"MAX\\_WITHOUT\\_INTEREST\" |\n| listName | string | Name of the list property in Google Analytics events. | \\- |\n| preferredSKU | [PreferredSKUEnum](#preferredskuenum) | Controls the SKU that will be selected in the summary. Possible values are: FIRST\\_AVAILABLE, LAST\\_AVAILABLE, PRICE\\_ASC, PRICE\\_DESC. | \"FIRST\\_AVAILABLE\" |\n\n### `SkusFilterEnum`:\n\n| Name | Value | Description |\n| --------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| First Available | FIRST\\_AVAILABLE | Best performance, ideal if you don't have a SKU selector on your shelf. It returns only the first available SKU for that product in your shelf query. |\n| All Available | ALL\\_AVAILABLE | Somewhat better performance. It only returns available SKUs, which is ideal if you have a SKU selector but still want better performance. |\n| All | ALL | Returns all SKUs related to the product. This is the least efficient option. |\n\n### `InstallmentCriteriaEnum`:\n\n| Name | Value | Description |\n| ------------------------ | ---------------------- | ----------------------------------------------------------------- |\n| Maximum without interest | MAX\\_WITHOUT\\_INTEREST | Displays the maximum installment option with no interest. |\n| Maximum | MAX\\_WITH\\_INTEREST | Displays the maximum installment option with or without interest. |\n\n### `PreferredSKUEnum`:\n\n| Name | Value | Description |\n| --------------- | ---------------- | -------------------------------------------------- |\n| First Available | FIRST\\_AVAILABLE | Selects the first available SKU it finds. |\n| Last Available | LAST\\_AVAILABLE | Selects the last available SKU it finds. |\n| Cheapest | PRICE\\_ASC | Selects the cheapest SKU in stock it finds. |\n| Most Expensive | PRICE\\_DESC | Selects the most expensive available SKU it finds. |\n\n> To select the SKU that will take precedence over this prop, create a Product (field) specification and assign the value of the desired SKU to be initially set for each product. If the specification doesn't exist or the value is empty, the `preferredSKU` prop will be used as a fallback. For more information, see [Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector).\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/ProductSummaryList/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[product-list-block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/apps/vtex.product-summary/ProductSummaryList%23product-list-block)\n\n[SkusFilterEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/apps/vtex.product-summary/ProductSummaryList%23skusfilterenum)[InstallmentCriteriaEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/apps/vtex.product-summary/ProductSummaryList%23installmentcriteriaenum)[PreferredSKUEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/apps/vtex.product-summary/ProductSummaryList%23preferredskuenum)\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_ab7511dc
|
[
{
"role": "system",
"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 trigger ab test 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/trigger-ab-test/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/api-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/trigger-ab-test/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/trigger-ab-test/docs/storefront-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/trigger-ab-test/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/trigger-ab-test/docs/troubleshooting)\n\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/trigger-ab-test/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/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/trigger-ab-test/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-triggers-on-master-data-v2)\n\n[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/trigger-ab-test)\n\n[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/sending-emails-with-triggers-on-master-data-v2)\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/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/trigger-ab-test/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/trigger-ab-test/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/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/trigger-ab-test/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-triggers-on-master-data-v2)\n\n[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/trigger-ab-test)\n\n[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/sending-emails-with-triggers-on-master-data-v2)\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/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/trigger-ab-test/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/trigger-ab-test/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-v2)\n\nTriggers\n\n[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/trigger-ab-test)\n\nA/B testing Master Data v2 trigger actions\n\nThe [Master Data v2 trigger](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/setting-up-triggers-on-master-data-v2) configuration has an optional property called `weight`.\n\nIt is a field that accepts integers between zero and 100\\. This number is a percentage value of distribution between triggers.\n\nThis allows you to perform comparative experiments with different actions for the same Master Data trigger.\n\n> This feature works only if you have at least two actions with value in the `weight` property.\n\nExample 1: A/B Test between two triggers with 50% of the load.\n\n`1\n\n { \n\n2\n\n \"properties\": { ... }, \n\n3\n\n \"v-triggers\": [ \n\n4\n\n { \n\n5\n\n \"name\": \"scenario-1\", \n\n6\n\n \"weight\": 50, \n\n7\n\n ... \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"name\": \"scenario-2\", \n\n11\n\n \"weight\": 50, \n\n12\n\n ... \n\n13\n\n } \n\n14\n\n ] \n\n15\n\n } \n\n`\n\nExample 2: A/B Test between four triggers with different weights.\n\n`1\n\n { \n\n2\n\n \"properties\": { ... }, \n\n3\n\n \"v-triggers\": [ \n\n4\n\n { \n\n5\n\n \"name\": \"scenario-1\", \n\n6\n\n \"weight\": 40, \n\n7\n\n ... \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"name\": \"scenario-2\", \n\n11\n\n \"weight\": 30, \n\n12\n\n ... \n\n13\n\n }, \n\n14\n\n { \n\n15\n\n \"name\": \"scenario-3\", \n\n16\n\n \"weight\": 20, \n\n17\n\n ... \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n \"name\": \"scenario-4\", \n\n21\n\n \"weight\": 10, \n\n22\n\n ... \n\n23\n\n } \n\n24\n\n ] \n\n25\n\n } \n\n`\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/trigger-ab-test.md)\n\n[Setting up triggers on Master Data v2« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test//docs/guides/setting-up-triggers-on-master-data-v2)[Sending emails with triggers on Master Data v2Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test//docs/guides/sending-emails-with-triggers-on-master-data-v2)\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/Master-Data/master-data-v2/triggers/trigger-ab-test.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_ebb1d16c
|
[
{
"role": "system",
"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 tracking 1 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/tracking-1/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/api-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/tracking-1/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/tracking-1/docs/storefront-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/tracking-1/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/tracking-1/docs/troubleshooting)\n\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/tracking-1/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/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/tracking-1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/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/tracking-1/docs/guides/vtex-shipping-network)\n\n[Getting started with VTEX IO for VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/getting-started-with-vtex-io-for-vtex-shipping-network)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/integration-flow)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/notification-1)\n\n[Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/tracking-1)\n\n[VTEX Shipping Network Labels Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-shipping-network-labels-integration)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/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/tracking-1/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/tracking-1/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/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/tracking-1/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/tracking-1/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/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/tracking-1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/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/tracking-1/docs/guides/vtex-shipping-network)\n\n[Getting started with VTEX IO for VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/getting-started-with-vtex-io-for-vtex-shipping-network)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/integration-flow)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/notification-1)\n\n[Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/tracking-1)\n\n[VTEX Shipping Network Labels Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-shipping-network-labels-integration)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/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/tracking-1/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/tracking-1/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/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/tracking-1/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/tracking-1/docs/guides)\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-shipping-network)\n\n[Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/tracking-1)\n\nTracking\n\nAccess the [boilerplate repository for the tracking app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/carrier-hubs-examples/tree/main/carrier-tracking-example) to clone it and begin development.\n\nA tracking app published by a carrier will include an endpoint like this one:`https://app.io.vtex.com/{app_name}/{app_version}/{account}/{workspace}/tracking`\n\nOnce every hour, the VTEX tracking hub makes a `POST` request to this endpoint containing a list of packages’ tracking numbers. The app should respond with the updated tracking information for each package.\n\nBelow are some examples, but you can learn more about this request on the [tracking API request documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/reference/vtex-log-tracking-app).\n\nRequest body example:\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"trackingNumber\": \"BR000000000\" \n\n4\n\n } \n\n5\n\n] \n\n`\n\nResponse body example:\n\n`1\n\n{ \n\n2\n\n <trackingNumber>: { \n\n3\n\n \"deliveredDate\": Date, \n\n4\n\n \"events\": [ \n\n5\n\n { \n\n6\n\n \"city\": string, \n\n7\n\n \"date\": Date, \n\n8\n\n \"description\": string, \n\n9\n\n \"state\": string \n\n10\n\n } \n\n11\n\n ], \n\n12\n\n \"hasReturnedToSender\": bool, \n\n13\n\n \"isDelivered\": bool \n\n14\n\n } \n\n15\n\n} \n\n`\n\n> Be aware that this call may contain several package's tracking numbers, and the app should respond with tracking information for each of them.\n\n## Learn more\n\nSee this guide on [how to develop carrier apps on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/getting-started-with-vtex-io-for-carriers). You can also learn more about the [integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/integration-flow) and [notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/notification-1) for carrier apps.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/Isabella-Veloso)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/vtex-shipping-network/tracking-1.md)\n\n[Notification« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1//docs/guides/notification-1)[VTEX Shipping Network Labels IntegrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1//docs/guides/vtex-shipping-network-labels-integration)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/Isabella-Veloso)\n\nON THIS PAGE\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/tracking-1%23learn-more)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/vtex-shipping-network/tracking-1.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/tracking-1%23learn-more)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d23f0985
|
[
{
"role": "system",
"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 relationships between data entities using master data v2 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v2)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\nCreating relationships between data entities using Master Data v2\n\nLearn how to create relationships between data entities in Master Data v2.\n\nThis document will teach you how to establish relationships between data entities in **Master Data v2**. Creating these relationships is vital for organizing and structuring data efficiently within your system.\n\n## Before you begin\n\nBefore delving into the process of creating relationships, it's essential to grasp the structure of JSON Schema. If you're not familiar with JSON Schema, we recommend referring to the external documentation, [Understanding JSON Schema](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema).\n\nTo learn more about schemas in Master Data v2, see [Schema lifecycle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-schema-lifecycle).\n\n## Establishing relationships\n\nUse the [Save schema by name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-) ednpoint to configure a field to link to another data entity using either the ID or a field with an associated [index](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components%23index) created using the [Create index](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/indices) endpoint.\n\nBelow are examples of both methods:\n\nLink through ID\n\n`1\n\n{ \n\n2\n\n \"properties\": { \n\n3\n\n \"clientEmail\": { \"type\": \"string\" }, \n\n4\n\n \"address\": { \n\n5\n\n \"type\": \"string\", \n\n6\n\n \"link\": \"https://vtexaccount.vtexcommercestable.com.br/api/dataentities/address/schemas/address-schema-v1\" \n\n7\n\n } \n\n8\n\n } \n\n9\n\n} \n\n`\n\nLink through a field with an index\n\n`1\n\n{ \n\n2\n\n \"properties\": { \n\n3\n\n \"clientEmail\": { \"type\": \"string\" }, \n\n4\n\n \"addressName\": { \n\n5\n\n \"type\": \"string\", \n\n6\n\n \"link\": \"https://vtexaccount.vtexcommercestable.com.br/api/dataentities/address/schemas/address-schema-v1\", \n\n7\n\n \"linked_field\": \"addressName\" \n\n8\n\n } \n\n9\n\n } \n\n10\n\n} \n\n`\n\nNotice that the `link` property associates a JSON Schema of the data entity with which you want to create a relationship.\n\n## Response handling\n\nCreating a relationship in this manner will generate a response containing a new field with the JSON of the related document.\n\nThe fields in the returned object will match those specified in the `v-default-fields`. However, if the document does not exist with the specified key, the property will be populated with `null`.\n\nExample of a [Get document request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/documents/-id-) without schema\n\n`GET` `/api/dataentities/client/documents/{id}?_fields={fields}`\n\n`1\n\n{ \n\n2\n\n \"clientEmail\": \"vtext@mail.com\", \n\n3\n\n \"address\": \"1\" \n\n4\n\n} \n\n`\n\nExample of a [Get document request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/documents/-id-) using a schema with a link\n\nIn this request, you must use the `_schema` and the `_fields` query parameters for the linked fields to return correctly.\n\n`GET` `/api/dataentities/client/documents/{id}?_schema={schema}&_fields={fields}`\n\n`1\n\n{ \n\n2\n\n \"clientEmail\": \"vtext@mail.com\", \n\n3\n\n \"address\": \"1\" \n\n4\n\n \"address_linked\": { \n\n5\n\n \"id\": \"1\" \n\n6\n\n \"city\": \"Rio de Janeiro\" \n\n7\n\n } \n\n8\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/creating-relationships-between-data-entities-using-master-data-v2.md)\n\n[Master Data v2 document saving flow« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2//docs/guides/master-data-v2-document-saving-flow)[Using dynamic expressions on Master Data v2Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2//docs/guides/using-dynamic-expressions-on-master-data-v2)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23before-you-begin)\n\n[Establishing relationships](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23establishing-relationships)\n\n[Response handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23response-handling)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/creating-relationships-between-data-entities-using-master-data-v2.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23before-you-begin)\n\n[Establishing relationships](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23establishing-relationships)\n\n[Response handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23response-handling)\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_bedcebbb
|
[
{
"role": "system",
"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 developer tools config options 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/developer-tools-config-options/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/api-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/developer-tools-config-options/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/developer-tools-config-options/docs/storefront-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/developer-tools-config-options/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/developer-tools-config-options/docs/troubleshooting)\n\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/developer-tools-config-options/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/developer-tools-config-options/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/developer-tools-config-options/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/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/developer-tools-config-options/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/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/developer-tools-config-options/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/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/developer-tools-config-options/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/developer-tools-config-options/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/developer-tools-config-options/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/developer-tools-config-options/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/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/developer-tools-config-options/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/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/developer-tools-config-options/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/developer-tools-config-options/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/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/developer-tools-config-options/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/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/developer-tools-config-options/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/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/developer-tools-config-options/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/developer-tools-config-options/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/developer-tools-config-options/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/developer-tools-config-options/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/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/developer-tools-config-options/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-overview)\n\nConfiguration options for discovery.config.js\n\nThe `discovery.config.js` is a configuration file for managing settings that control store behavior, appearance, and functionality. This file serves as a central hub for configuring key aspects of your FastStore website, including SEO, API connections, session management, analytics, and more.\n\nThis guide outlines the configuration options for tailoring your FastStore website using the `discovery.config.js` file.\n\n## Example file\n\n`1\n\nmodule.exports = { \n\n2\n\n seo: { \n\n3\n\n title: \"FastStore Starter\", \n\n4\n\n description: \"Fast Demo Store\", \n\n5\n\n titleTemplate: \"%s | FastStore\", \n\n6\n\n author: \"FastStore\", \n\n7\n\n }, \n\n8\n\n theme: \"custom-theme\", \n\n9\n\n platform: \"vtex\", \n\n10\n\n api: { \n\n11\n\n storeId: \"storeframework\", \n\n12\n\n workspace: \"master\", \n\n13\n\n environment: \"vtexcommercestable\", \n\n14\n\n hideUnavailableItems: false, \n\n15\n\n incrementAddress: false, \n\n16\n\n }, \n\n17\n\n}; \n\n`\n\nCheck the full file example at [discovery.config.js sample code](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/starter.store/blob/main/discovery.config.js).\n\n> As of December 16, 2024, `discovery.config.js` is the new filename for the legacy `faststore.config.js` file. If you're still using the legacy name, see [this release note](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2024-12-16-discovery-config-file) to update it.\n\n## Configuration options\n\nBelow is a description of each setting you can configure in the `discovery.config.js` file:\n\n### `seo`\n\nSets default metadata related to Search Engine Optimization (SEO), influencing how your store appears in search results. Learn more in [SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview).\n\n| Property | Type | Description | Example |\n| ------------- | ------ | ----------------------------------------------------------------------- | ---------------------- |\n| title | string | Store headline displayed in search results (60 characters recommended). | \"FastStore Starter\" |\n| description | string | Brief description of the store (150-160 characters optimal). | \"FastStore Demo Store\" |\n| titleTemplate | string | Dynamic page title pattern. Use %s as a placeholder. | \"%s \\| FastStore\" |\n| author | string | Content author/owner for attribution. | \"FastStore\" |\n\n---\n\n### `theme`\n\nDefines the visual identity of your FastStore project, including color schemes, typography, and layout presets. This field is a `string` that specifies the name of the theme being used.\n\nEvery FastStore project starts with the [Brandless theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview%23brandless-and-the-theming-structure) by default. However, you can choose from available themes or develop a custom theme. Learn more in [Themes - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview).\n\n---\n\n### `platform`\n\nDefines the ecommerce platform being used. You must set `vtex` as a value to enable VTEX-specific features.\n\n> Only `vtex` is a valid value. Any other value will cause errors.\n\n---\n\n### `api`\n\nContains settings related to the store's APIs, which link your FastStore storefront to backend services and manage environment-specific behavior.\n\n| Property | Type | Description | Example |\n| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |\n| storeId | string | VTEX account being used. | \"mystore\" |\n| workspace | string | Workspace being used. Use master for the production environment, and other names for staging. | \"master\" |\n| environment | string | API environment. | \"vtexcommercestable\" |\n| hideUnavailableItems | boolean | Controls product display. When true, hides out-of-stock products. Default value is false. | false |\n| incrementAddress | boolean | Enables automatic completion of address details during checkout using [VTEX’s address API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code). When true, missing address fields (such as city, state, street, etc.) are automatically filled based on the provided postal code. Default value is false. | false |\n\n---\n\n### `session`\n\nSets up user session defaults, controlling language, currency, location, and shopper attributes.\n\n| Property | Type | Description | Example |\n| --------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |\n| currency | object | Store’s transactional currency for prices, payment, and checkout. | |\n| ├─ code | string | ISO currency code | \"USD\" |\n| └─ symbol | string | Currency symbol | \"$\" |\n| locale | string | Language or locale setting for all store text, dates, and numbers. Use standard locale format like en-US for English (US), pt-BR for Brazilian Portuguese, etc. | \"en-US\" |\n| channel | object | Identifies the commercial and regional context for handling catalog, pricing, and logistics. | |\n| ├─ salesChannel | string | Trade policy that handles catalog, prices, and fulfillment options (example: different regions or seller-specific rules). | \"1\" |\n| └─ regionId | string | Internal identifier used to define regional segmentation based on the user’s location for services such as catalog, shipping, pickup, and other logistics-related processes. | |\n| country | string | ISO country code for the current shopper’s session. This field informs VTEX services which country’s regulations, delivery logistics, and tax rules must be applied. | \"US\" |\n| deliveryMode | string | Order fulfillment method, including delivery channel, selected courier or method, delivery window (start and end times), or pickup point. | \"delivery\" |\n| addressType | string | Address format for fulfillment | \"residential\" |\n| postalCode | string | User’s postal code | \"10001\" |\n| geoCoordinates | float\\[\\] | User’s location as \\[latitude, longitude\\] | \\[40.7128, -74.0060\\] |\n| person | object | Shopper identity attributes. | |\n| ├─ id | string | Unique VTEX customer ID. VTEX Identity service may auto-populate these fields after sign-in. | \"12345\" |\n| ├─ email | string | Customer’s email address | \"user@email.com\" |\n| ├─ firstName | string | Customer’s first name. | \"Alex\" |\n| └─ lastName | string | Customer’s last name. | \"Smith\" |\n\n---\n\n### `cart`\n\nContains the settings to manage the shopping cart’s contents and behavior.\n\n| Property | Type | Description | Example |\n| --------------- | ---------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------- |\n| id | string | Unique identifier of the cart. | \"cart-abc-123\" |\n| items | array | Products added to the cart. | \\[{\"sku\": \"5678\", \"quantity\": 2}\\] |\n| messages | string\\[\\] | System messages associated with the cart, such as shipping changes or other relevant information. | \\[\"Shipping updated\"\\] |\n| shouldSplitItem | boolean | If true, allows cart items from multiple sellers or differing stock locations to be shipped separately. | true |\n\n---\n\n### `storeUrl`\n\nDefines the primary store domain as a string. Example: `https://www.mystore.com`.\n\n### `secureSubdomain`\n\nDefines the HTTPS-enabled subdomain, if used, as a string. Example: `https://secure.mystore.com`.\n\n### `checkoutUrl`\n\nDefines the URL for the checkout process as a string. Example: `https://www.mystore.com/checkout`.\n\n### `loginUrl`\n\nDefines the URL for the login process as a string. Example: `https://www.mystore.com/login`.\n\n### `accountUrl`\n\nDefines the URL for the customer's account management page as a string. Example: `https://www.mystore.com/account`.\n\nLearn more about store domains in [Associating your custom domain with your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns%23step-4-associating-your-custom-domain-with-your-faststore-project).\n\n---\n\n### `previewRedirects`\n\nMaps redirect URLs for the following page types in preview mode.\n\n| Property | Type | Description | Example |\n| -------- | ------ | --------------------------------------------- | -------------------------------------- |\n| home | string | Redirect URL for the homepage. | \"https://preview.mystore.com\" |\n| plp | string | Redirect URL for product listing pages (PLP). | \"https://preview.mystore.com/category\" |\n| search | string | Redirect URL for search results pages. | \"https://preview.mystore.com/search\" |\n| pdp | string | Redirect URL for product detail pages (PDP). | \"https://preview.mystore.com/product\" |\n\nLearn more in [Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths).\n\n---\n\n### `lighthouse`\n\nIncludes settings for [Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview), a tool for auditing and improving the quality of web pages.\n\n| Property | Type | Description | Example |\n| ------------- | ------ | -------------------------------------------------- | ------------------------------------------------------ |\n| server | string | The server URL for running Lighthouse audits. | process.env.BASE\\_SITE\\_URL \\| 'http://localhost:3000' |\n| pages | object | Maps the URL of pages to be audited by Lighthouse. | |\n| ├─ home | string | URL of the homepage. | '/' |\n| ├─ pdp | string | URL of a product detail page. | \"/headphone-white-10000006/p\" |\n| └─ collection | string | URL of a collection page. | \"/headphones\" |\n\nLearn more in [Lighthouse Scores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23lighthouse-scores).\n\n---\n\n### `cypress`\n\nDefines which pages [Cypress](https://read.calvincode.net/reader?url=https://docs.cypress.io/app/get-started/why-cypress) should visit in end-to-end tests, ensuring predictable routes for the CI pipeline. Prefer relative URLs (for example, `\"/\"`, `/headphones`) and deterministic scenarios with consistent data across runs.\n\n| Property | Type | Description | Example |\n| ----------------------- | ------ | ------------------------------------------------------------------------------------------------ | -------------------------------- |\n| pages | object | Maps the URLs of pages for end-to-end testing with Cypress, with each field defined as a string. | |\n| ├─ home | string | URL of the homepage. | \"/\" |\n| ├─ pdp | string | URL of the product detail page. | \"/headphone-white-10000006/p\" |\n| ├─ collection | string | URL of a collection page. | \"/headphones\" |\n| ├─ collection\\_2 | string | URL of a secondary collection page. | \"/audio\" |\n| ├─ collection\\_filtered | string | URL of a filtered collection page. | \"/headphones?priceRange=100-200\" |\n| └─ search | string | URL of a search results page. | \"/s?q=headphone\" |\n\nLearn more in [enableCypressExtension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress).\n\n---\n\n### `analytics`\n\nDefines the [Google Tag Manager ID](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/12326985?hl=en%26ref%5Ftopic=14595647%26sjid=12859079805529639111-SA) used by the site to collect events and trigger tags, allowing you to measure interactions, funnels, and conversions.\n\n| Property | Type | Description | Example |\n| -------------- | ------ | ------------------------------------ | ------------- |\n| gtmContainerId | string | The Google Tag Manager container ID. | \"GTM-1234567\" |\n\nLearn more in [Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview).\n\n---\n\n### `experimental`\n\nContains settings for experimental features.\n\n| Property | Type | Description | Example |\n| ----------------------- | ------ | -------------------------------------------------------------------------------- | ------- |\n| nodeVersion | string | The Node.js version. | \"20\" |\n| cypressVersion | string | The Cypress version. | \"13\" |\n| graphqlCacheControl | object | Settings for GraphQL responses. | |\n| ├─ maxAge | number | Maximum time (in seconds) that the response can be cached. | 300 |\n| └─ staleWhileRevalidate | number | Time (in seconds) during which stale responses can be served while revalidating. | 60 |\n\n---\n\n### `account`\n\nSpecifies the VTEX account name used by the project as a string. Example: `mystore`.\n\n---\n\n### `vtexHeadlessCms`\n\nConfigures webhook endpoints for [VTEX Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) to trigger publishing, cache invalidation, or content preview whenever changes occur in the CMS.\n\n| Property | Type | Description | Example |\n| ----------- | ---------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------- |\n| webhookUrls | array of strings | An array of strings that defines the webhook URLs used to interact with the Headless CMS. | \\[\"https://mystore.myvtex.com/cms-releases/webhook-releases\"\\] |\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/config-options.mdx)\n\n[Developer tools and references« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-overview)[Custom Cypress integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-custom-cypress)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Example file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23example-file)\n\n[Configuration options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23configuration-options)\n\n[seo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23seo)[theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23theme)[platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23platform)[api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23api)[session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23session)[cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23cart)[storeUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23storeurl)[secureSubdomain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23securesubdomain)[checkoutUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23checkouturl)[loginUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23loginurl)[accountUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23accounturl)[previewRedirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23previewredirects)[lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23lighthouse)[cypress](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23cypress)[analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23analytics)[experimental](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23experimental)[account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23account)[vtexHeadlessCms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23vtexheadlesscms)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/config-options.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Example file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23example-file)\n\n[Configuration options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23configuration-options)\n\n[seo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23seo)[theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23theme)[platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23platform)[api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23api)[session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23session)[cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23cart)[storeUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23storeurl)[secureSubdomain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23securesubdomain)[checkoutUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23checkouturl)[loginUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23loginurl)[accountUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23accounturl)[previewRedirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23previewredirects)[lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23lighthouse)[cypress](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23cypress)[analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23analytics)[experimental](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23experimental)[account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23account)[vtexHeadlessCms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23vtexheadlesscms)\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_5054e531
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore getting started 3 running the project locally in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-overview)\n\n3\\. Running the project locally\n\nRun your FastStore project in a local development environment to preview changes in real time.\n\nIn this step, you'll set up your local development environment, allowing you to iterate quickly and safely before shipping changes. Running the project locally gives you hot reload, faster feedback, and a stable foundation for customization.\n\n## What you'll accomplish\n\nBy the end of this step, you will have:\n\n* Run your project locally (<http://localhost:3000/>)\n* Made your first customization by applying a new theme to your storefront\n\n## Before you begin\n\n### Required tooling\n\nBefore cloning your store’s repository, make sure the following tools are installed on your machine:\n\nNode.js\n\nTo run your FastStore project, install the latest Node.js or a version higher than `15.0.0`.\n\n* [Install Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/en/download)\nYarn\n\nUse the [Yarn](https://read.calvincode.net/reader?url=https://yarnpkg.com/) CLI to manage dependencies and run tasks, such as starting the development server.\n\nInstall Yarn on macOS by running the following:\n\n`1\n\nbrew install yarn \n\n`\n\nInstall Yarn on Windows by running the following:\n\n`1\n\nnpm install -g yarn \n\n`\n\nGit\n\nWhen developing your store's website, you will use [Git](https://read.calvincode.net/reader?url=https://git-scm.com/) to push your code to the cloud. You will also use Git to download and install the required files for your project.\n\n* [Install Git on macOS using Homebrew](https://read.calvincode.net/reader?url=https://git-scm.com/download/mac)\n* [Install Git on Windows](https://read.calvincode.net/reader?url=https://git-scm.com/download/win)\n* [Install Git on Linux](https://read.calvincode.net/reader?url=https://git-scm.com/download/linux)\nVisual Studio Code - Code Editor\n\nWhen developing your store's website, you will need a code editor to write the code for your project, such as [Visual Studio Code](https://read.calvincode.net/reader?url=https://code.visualstudio.com/) (also known as VS Code). Visit the [VS Code](https://read.calvincode.net/reader?url=https://code.visualstudio.com/) website, download, and install the version compatible with your operating system.\n\n> Although you might opt to use an alternative code editor, note that [Visual Studio Code](https://read.calvincode.net/reader?url=https://code.visualstudio.com/) might help you follow along with the FastStore documentation since our documentation may include screenshots from VS Code.\n\n### Enabling Developer Mode (Windows users)\n\nWe strongly recommend enabling Developer Mode when using the terminal for FastStore projects. Since FastStore projects rely on creating symlinks, this mode grants the necessary permissions and privileges, reducing the chance of errors during development. To activate Developer Mode, refer to Microsoft's official guide on [Enabling your device for development](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development%23accessing-settings-for-developers).\n\n> Running the FastStore project as an Administrator is not recommended.\n\n## Step 1: Cloning the store's repository\n\n1. Open the terminal and navigate to the directory where you want to store your project. \n> For Windows users, we highly recommend enabling the [Developer Mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project%23enabling-developer-mode-windows-users) to run the terminal.\n2. Clone the repository created during the [FastStore Onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project%23step-2-deploying-the-project) by running the following command in the terminal: \n`1 \ngit clone https://github.com/{orgName}/{storeName} \n` \n> Replace `{orgName}` with the GitHub organization where your store's repository is located, and `{storeName}` with the name of your store's repository.\n3. Change into the working directory by running the following command: \n`1 \ncd {storeName} \n`\n4. Install all the dependencies listed in the `package.json` file by running the following command: \n`1 \nyarn install \n`\n5. Open your FastStore project in any code editor of your choice.\n\n> Note that your store configuration was already set during the [FastStore Onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project). Therefore, there is no need to connect your project to your VTEX account.\n\nIf you want to review these configurations, you can access the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options) file in the root directory of your project's repository.\n\n## Step 2: Running a local server\n\nLet's check what the project looks like in a web browser so far.\n\n1. Start a local development server to serve your website: \n`1 \n yarn dev \n` \nThis may take a few minutes. Once your development server is ready, the command line will output a similar message as the following: \n`1 \n ready - started server on 0.0.0.0:3000, url: http://localhost:3000 \n2 \n event - compiled client and server successfully in 333 ms (951 modules) \n` \n> The `dev` command is part of the [FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli), a pre-configured command line interface in your starter project. Using the CLI, this command enables you to execute code to keep your store's project up-to-date with the [@faststore/core package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson).\n2. Now, open your browser and go to <http://localhost:3000>. \n\n\nWhile the development server is running, changes you save are hot-reloaded in the browser. To stop the server, press `Ctrl + C` in the terminal. To restart it, run `yarn dev` again.\n\n## Step 3: Making the first change in your store frontend\n\nNow that your store is up and running locally, let's make a simple change in the storefront.\n\nWe will start updating the store's [theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview%23available-themes). For this customization, we will use the [Soft Blue theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue).\n\n1. Create a new file named `soft-blue.scss` in `src/themes`. This will be the new theme of your store.\n2. Add the following styles to `src/themes/soft-blue.scss`: \nsrc/themes/soft-blue.scss \n`1 \n// ---------------------------------------------------------- \n2 \n// GLOBAL TOKENS \n3 \n// Theme Soft Blue \n4 \n// ---------------------------------------------------------- \n5 \n \n6 \n@layer theme { \n7 \n .theme { \n8 \n // -------------------------------------------------------- \n9 \n // Colors (Branding Core) \n10 \n // -------------------------------------------------------- \n11 \n \n12 \n // PALETTE \n13 \n --fs-color-main-0: #ecf0ff; \n14 \n --fs-color-main-1: #d8e2ff; \n15 \n --fs-color-main-2: #00419e; \n16 \n --fs-color-main-3: #002c71; \n17 \n --fs-color-main-4: #001947; \n18 \n \n19 \n --fs-color-accent-0: #ebdcff; \n20 \n --fs-color-accent-1: #8d50fd; \n21 \n --fs-color-accent-2: #732fe2; \n22 \n --fs-color-accent-3: #5900c8; \n23 \n --fs-color-accent-4: #4700a0; \n24 \n \n25 \n // HIERARCHY \n26 \n --fs-color-primary-bkg: var(--fs-color-main-4); \n27 \n --fs-color-primary-bkg-active: var(--fs-color-main-2); \n28 \n --fs-color-primary-bkg-light: var(--fs-color-main-0); \n29 \n --fs-color-primary-bkg-light-active: var(--fs-color-main-1); \n30 \n \n31 \n // SITUATIONS \n32 \n --fs-color-success-bkg: #cee8de; \n33 \n --fs-color-warning-bkg: #f6e0ba; \n34 \n \n35 \n // COMPONENTS & STATES \n36 \n --fs-color-text-display: var(--fs-color-main-4); \n37 \n \n38 \n --fs-color-action-bkg: var(--fs-color-accent-3); \n39 \n --fs-color-action-bkg-hover: var(--fs-color-accent-2); \n40 \n --fs-color-action-bkg-active: var(--fs-color-accent-1); \n41 \n \n42 \n // -------------------------------------------------------- \n43 \n // Typography (Branding Core) \n44 \n // -------------------------------------------------------- \n45 \n \n46 \n // FACE \n47 \n --fs-text-face-body: 'Lato', -apple-system, system-ui, BlinkMacSystemFont, sans-serif; \n48 \n \n49 \n // -------------------------------------------------------- \n50 \n // Refinements \n51 \n // -------------------------------------------------------- \n52 \n \n53 \n // BORDERS \n54 \n --fs-border-radius: 0.25rem; \n55 \n \n56 \n // SHADOW \n57 \n --fs-shadow: none; \n58 \n --fs-shadow-darker: 0 0 10px rgb(0 0 0 / 20%); \n59 \n --fs-shadow-hover: 0 1px 4px rgb(0 0 0 / 10%), 0 6px 8px rgb(0 0 0 / 10%); \n60 \n \n61 \n // -------------------------------------------------------- \n62 \n // FS UI Components \n63 \n // -------------------------------------------------------- \n64 \n // Add here the customizations for FastStore UI components. \n65 \n \n66 \n --fs-logo-width: 8rem; \n67 \n \n68 \n [data-fs-product-card] { \n69 \n --fs-product-card-border-color: transparent; \n70 \n --fs-product-card-border-color-hover: var(--fs-border-color-light); \n71 \n \n72 \n &[data-fs-product-card-bordered='true'] { \n73 \n --fs-product-card-border-color: var(--fs-border-color-light); \n74 \n } \n75 \n } \n76 \n } \n77 \n} \n`\n3. Open the `discovery.config.js` file and change the `theme` from `custom-theme` to `soft-blue`. \ndiscovery.config.js \n`1 \n theme: 'soft-blue', \n`\n4. Restart the server and check in the browser the new theme applied to your store. You may need to refresh the page. \n \n> It is important to highlight that the store's logo is set through the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview).\n\n## Next step\n\nNow that your local environment is running, learn about your project's structure to understand where to make customizations: [4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-project-structure)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/3-running-the-project-locally.mdx)\n\n[2\\. Starting a new FastStore project« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-2-starting-the-project)[4\\. Understanding the project structureNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23what-youll-accomplish)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23before-you-begin)\n\n[Required tooling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23required-tooling)[Enabling Developer Mode (Windows users)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23enabling-developer-mode-windows-users)\n\n[Step 1: Cloning the store's repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-1-cloning-the-stores-repository)\n\n[Step 2: Running a local server](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-2-running-a-local-server)\n\n[Step 3: Making the first change in your store frontend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-3-making-the-first-change-in-your-store-frontend)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23next-step)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/3-running-the-project-locally.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23what-youll-accomplish)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23before-you-begin)\n\n[Required tooling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23required-tooling)[Enabling Developer Mode (Windows users)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23enabling-developer-mode-windows-users)\n\n[Step 1: Cloning the store's repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-1-cloning-the-stores-repository)\n\n[Step 2: Running a local server](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-2-running-a-local-server)\n\n[Step 3: Making the first change in your store frontend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-3-making-the-first-change-in-your-store-frontend)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23next-step)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_27eb059d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore go live before you begin in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-before-you-begin)\n\n[1\\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-1-configuring-external-dns)\n\n[2\\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-2-integrating-the-vtex-login)\n\n[3\\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)\n\n[4\\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-before-you-begin)\n\n[1\\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-1-configuring-external-dns)\n\n[2\\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-2-integrating-the-vtex-login)\n\n[3\\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)\n\n[4\\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-overview)\n\nBefore you begin\n\nBefore each production goes live, contact the FastStore team at least four weeks before the date and make sure that the following is complete:\n\n### Configured the account edition\n\nYour account edition is set to `vtex.edition-store@5.x` Edition app in your master workspace.\n\n> If you do not have the appropriate Edition app installed, [open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support) requesting the installation of the `vtex.edition-store@5.x Edition` app in your master workspace.\n\n### Deployed the project with FastStore WebOps\n\nThe project was deployed with [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) app.\n\n### Developed the storefront\n\nThe storefront was developed during the [Setting Up the Project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project).\n\n## Next\n\nNow, start integrating your FastStore project with VTEX by [Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns).\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/go-live/before-you-begin.mdx)\n\n[Going live« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-overview)[1\\. Configuring external DNSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-1-configuring-external-dns)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Next](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-before-you-begin%23next)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/before-you-begin.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Next](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-before-you-begin%23next)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e55238f6
|
[
{
"role": "system",
"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 search provider 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/external-search-provider-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-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/external-search-provider-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/external-search-provider-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/external-search-provider-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/external-search-provider-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/external-search-provider-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-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/external-search-provider-overview/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/search-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-recipe)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-reference)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-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/external-search-provider-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-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/external-search-provider-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/external-search-provider-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-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/external-search-provider-overview/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/search-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-recipe)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-reference)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-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/external-search-provider-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-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/external-search-provider-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/external-search-provider-overview/docs/guides)\n\nIntegration Guides\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/search-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-overview)\n\nVTEX Search Protocol\n\nA search engine is a crucial part of ecommerce. It can drive more sales if the search results are good and it can worsen the user experience if they are bad.\n\nChanging the search provider usually involved changing code both in the frontend and in the backend, creating unnecessary friction.\n\nThe idea behind the VTEX search protocol is to provide a clear contract between any VTEX store on VTEX IO and a search provider defined by a GraphQL schema. This contract enables low-effort switching between different search engines. And it also helps to speed up the development process of integration with a new search provider, because the integration will be completely decoupled from the frontend components.\n\nSearch protocol benefits both developers and VTEX stores!\n\n## How it Works\n\nThe **VTEX Search Protocol** is a set of definitions and GraphQL schemas that allows VTEX IO applications to serve **ecommerce search results** that can be used by VTEX Store Framework.\n\n\n\nCreating a **search-resolver** service app on VTEX IO, which implements VTEX Search Protocol, allows any VTEX Account using VTEX IO to **install such an application** and, instantly, **change the store's provider for search results.** This is really useful as no frontend modification is required. It's also possible to distribute the search provider on [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/) to make the installation process even simpler. \n\n### Search Schema\n\nThe **GraphQL schema** for VTEX Search Protocol defines the set of **queries** necessary for Store Framework to retrieve search information. This also includes the appropriate GraphQL types that any search resolver app should respond to.\n\nYou can check this schema on the **vtex.search-graphql** app [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-graphql). The schema definition is on `graphql/schema.graphql` but there's also a reference on the repository's `README.md`.\n\n## Implementation Pre-requisites\n\n* Access to a user in a VTEX account, with permissions to link and install apps\n* TypeScript and Node.js familiarity\n* [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/) familiarity\n\n[Back](search-integration-guide)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/search-integration-guide/external-search-provider-overview.md)\n\n[Search Protocol« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview//docs/guides/search-integration-guide)[SpecificationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview//docs/guides/external-search-provider-specification)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\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/external-search-provider-overview/docs/guides/external-search-provider-overview%23how-it-works)\n\n[Search Schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-overview%23search-schema)\n\n[Implementation Pre-requisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-overview%23implementation-pre-requisites)\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/search-integration-guide/external-search-provider-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/external-search-provider-overview/docs/guides/external-search-provider-overview%23how-it-works)\n\n[Search Schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-overview%23search-schema)\n\n[Implementation Pre-requisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview/docs/guides/external-search-provider-overview%23implementation-pre-requisites)\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_801c16a8
|
[
{
"role": "system",
"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 overview in VTEX."
},
{
"role": "assistant",
"content": " ⨉ \n\n# Share your feedback about this doc!\n\n Tell us about your experience with our documentation.\n\n Was this article helpful to you? \n\nHow can we improve this article? \n\nEmail address \n\nCan we reach out to you if we have any questions? \n\nYes \n\nNo\n\nSubmit \n\nDocumentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\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-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/overrides-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/overrides-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/overrides-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/overrides-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/overrides-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/overrides-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/overrides-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/overrides-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-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/overrides-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-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/overrides-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/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-overview/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-overview/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-overview/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-overview/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/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-overview/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-overview/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-overview/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-overview/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-overview/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-overview/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-overview/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-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/overrides-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/overrides-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-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/overrides-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/overrides-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-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/overrides-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/overrides-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-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/overrides-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-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/overrides-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/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-overview/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-overview/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-overview/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-overview/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/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-overview/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-overview/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-overview/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-overview/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-overview/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-overview/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-overview/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-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/overrides-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/overrides-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-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/overrides-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/overrides-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/overrides-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\nSection override\n\nOverrides allow you to replace native components within sections with custom ones. This maintains the core functionalities of native components while allowing you to adjust their appearance and behavior to suit the needs of your store.\n\nAll component customizations happen within sections. You can create multiple overrides for native sections, creating a new React component representing the overridden section.\n\n> Sections are native components that group other components to create specific parts of your store page, such as [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero), which includes components like `Hero`, `HeroImage`, and `HeroHeader`, simplifying the process of building cohesive layouts.\n\n## Override options\n\nThere are three options to customize your component through overrides:\n\n* **Overriding component props:** Change a component's behavior by [passing additional props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props) to it in your store code.\n* **Overriding a section:** [Build a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-native-component) based on its native equivalent to achieve the desired functionality.\n* **Overriding section styles:** Customize the look and feel of a section without changing its functionality by overriding its [styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles).\n\n## Available sections for overrides\n\nCheck the available sections and their components in the [List of native sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections) guide. Also, check the sections equivalent [Headless CMS schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-3-adding-content-types-and-sections%23step-3-adding-sections-to-the-headless-cms).\n\nOnce you define the section you want to change, you can choose to override only its props or the whole section structure.\n\n### `__experimental` components\n\nSome sections may contain components labeled with `__experimental`. These components are being migrated to [FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index) and may present limitations. While they are not yet fully migrated, `__experimental` components are available for use but not for overriding options.\n\n## Headless CMS customization and overrides\n\nKeep in mind that customizations made directly in the VTEX Admin through the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) take priority over code-based overrides.\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/overview.mdx)\n\n[Developing and overriding UI components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/developing-and-overriding-components-overview)[Overriding native component's propsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/overrides-component-props)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Override options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/overrides-overview%23override-options)\n\n[Available sections for overrides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/overrides-overview%23available-sections-for-overrides)\n\n[\\_\\_experimental components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/overrides-overview%23experimental-components)\n\n[Headless CMS customization and overrides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/overrides-overview%23headless-cms-customization-and-overrides)\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/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Override options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/overrides-overview%23override-options)\n\n[Available sections for overrides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/overrides-overview%23available-sections-for-overrides)\n\n[\\_\\_experimental components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/overrides-overview%23experimental-components)\n\n[Headless CMS customization and overrides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview/docs/guides/faststore/overrides-overview%23headless-cms-customization-and-overrides)\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_73268a42
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides services 4 using events as triggers in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/developing-services-on-vtex-io)\n\n[1\\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-1-getting-started-with-the-boilerplate)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-2-handling-and-receiving-events)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-3-using-the-analytics-client)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-4-using-events-as-triggers)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-5-using-the-master-data-client)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/developing-services-on-vtex-io)\n\n[1\\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-1-getting-started-with-the-boilerplate)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-2-handling-and-receiving-events)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-3-using-the-analytics-client)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-4-using-events-as-triggers)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-5-using-the-master-data-client)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/developing-services-on-vtex-io)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-4-using-events-as-triggers)\n\n4\\. Using events as triggers\n\nNow that we have successfully implemented the Analytics client, our next goal is to leverage events fired by the `events-example` app as triggers for requests to the Analytics client. This approach ensures that with every event received, we make a corresponding request to the Analytics client, resulting in updated data for live product visualizations every 3 seconds.\n\n## Using the Analytics client as a event handler\n\nAs the Analytics client is already implemented, we can use it in our event handler function. First, in the `service-course-template/node/event/liveUsersUpdate.ts` file, import the client we implemented in the previous step and the `EventContext` from the `@vtex/api` package to access the Analytics client that is within the `ctx` object. Finally, use the `getLiveUsers()` method the Analytics client implements and log the fetched data.\n\n## Linking the app\n\nRun `vtex link`. For every event fired, you should see the live users retrieved from the Analytics client.\n\nservice-course-template/node/event/liveUsersUpdate.ts\n\n`1\n\nimport { Clients } from '../clients/index' \n\n2\n\nimport { EventContext } from '@vtex/api' \n\n3\n\n \n4\n\nexport async function updateLiveUsers(ctx: EventContext<Clients>) { \n\n5\n\n const liveUsersProducts = await ctx.clients.analytics.getLiveUsers() \n\n6\n\n console.log('LIVE USERS: ', liveUsersProducts) \n\n7\n\n return true \n\n8\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-4-using-events-as-triggers.mdx)\n\n[3\\. Using the Analytics client« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers//docs/guides/services-3-using-the-analytics-client)[5\\. Using the Master Data clientNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers//docs/guides/services-5-using-the-master-data-client)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Using the Analytics client as a event handler](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-4-using-events-as-triggers%23using-the-analytics-client-as-a-event-handler)\n\n[Linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-4-using-events-as-triggers%23linking-the-app)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-4-using-events-as-triggers.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Using the Analytics client as a event handler](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-4-using-events-as-triggers%23using-the-analytics-client-as-a-event-handler)\n\n[Linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers/docs/guides/services-4-using-events-as-triggers%23linking-the-app)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_59305c2d
|
[
{
"role": "system",
"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 session client 1.0.5 session client 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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-graphql-api/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-graphql-api/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client)\n\n[Session Client GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-graphql-api/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-graphql-api/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client)\n\n[Session Client GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-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.session-client@1.0.5/session-client-graphql-api/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/guides/functional-apps)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client)\n\nSession Client GraphQL API\n\n[vtex.session-client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client)\n\nVersion: 1.0.5\n\nLatest version: 1.0.5\n\nThis API manages the [vtex\\_session cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23vtexsession-cookie), which holds session-related data for users. Developers can either interact with the API endpoints directly or declare this app as a dependency to leverage its [React functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client%23react-hooks).\n\n## Schema overview\n\n### Query\n\nsession\n\npossibleType\n\npossibleType\n\nQuery\n\nString version\n\nsession(items \\[String\\]) : Session\n\nSessionError\n\nString type\n\nString message\n\nSessionSuccess\n\nString! id\n\nSessionNamespaces namespaces\n\nSession\n\n| Field | (argument) | Type | Description |\n| ----------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **session** | [Session](#session) | Retrieves the vtex\\_session cookie content if successful. The [Get session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/session-manager-api%23get-/api/sessions) endpoint from the Session Manager API is an equivalent implementation in REST. The Session union has two possible types: SessionError and SessionSuccess. | |\n| items | \\[String\\] | Specifies the items from the vtex\\_session cookie that will be returned in the response. Each string defines the namespace and value of the items, with the \"{namespace}.{value}\" format. If this argument isn't declared, the response will have all the items in the namespace field. Example: \\[\"store.channel\", \"store.countryCode\", \"impersonate.canImpersonate\"\\]. | |\n\n### Mutation\n\nupdateSession\n\npossibleType\n\npossibleType\n\nMutation\n\nupdateSession(fields SessionFieldsJSONInput!, items \\[String\\]) : Session\n\nSessionError\n\nString type\n\nString message\n\nSessionSuccess\n\nString! id\n\nSessionNamespaces namespaces\n\nSession\n\n| Field | (argument) | Type | Description |\n| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **updateSession** | [Session](#session) | Updates fields in the public namespace of the vtex\\_session cookie and returns the updated content. The [Edit session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/session-manager-api%23patch-/api/sessions) endpoint from the Session Manager API is an equivalent implementation in REST. The Session union has two possible types: SessionError and SessionSuccess. | |\n| fields | SessionFieldsJSONInput! | A JSON object with the public fields to be updated. Since this is equivalent to a PATCH request, the request will have the following behavior with this field: Fields that exist in the cookie and aren't declared in this field will not be changed.Fields that exist in the cookie and are declared in this field will have their values updated.Fields that don't exist in the cookie and are declared in this field will be created.Example: { \"foo\": 123, \"baz\": \"abc\" }. | |\n| items | \\[String\\] | Specifies the items from the vtex\\_session cookie that will be returned in the response. Each string defines the namespace and value of the items. If this argument isn't declared, the response will have all the items in the namespace field. Example: \\[\"store.channel\", \"store.countryCode\", \"impersonate.canImpersonate\"\\].Tip: To only show the updated fields in the response, use the public namespace along with the field name. Example: \\[\"public.supportedLocales\"\\]. | |\n\n## Schema description\n\n> Arguments must be provided by the user. Required fields are marked with an exclamation mark (`!`).\n\n### SessionError\n\n| Field | (argument) | Type | Description |\n| ----------- | ---------- | ---------------------- | ----------- |\n| **type** | String | Session error type. | |\n| **message** | String | Session error message. | |\n\n[Session](#session) 🔽\n\n### SessionSuccess\n\n| Field | (argument) | Type | Description |\n| -------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **id** | String! | Session ID. | |\n| **namespaces** | SessionNamespaces | Namespaces object with the content of the vtex\\_session cookie. Each namespace has fields with specific information about the session. Check all the possible namespaces in the [Sessions System documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23vtexsession-cookie). | |\n\n[Session](#session) 🔽\n\n### Session\n\n| Type | Description |\n| ------------------------------------- | ------------------------------------------------------------------------------------ |\n| **[SessionError](#sessionerror)** | Returned when a session error occurs. It provides the error type and message. |\n| **[SessionSuccess](#sessionsuccess)** | Returned when the operation succeeds. It includes the content of the session cookie. |\n\n[Query](#query) 🔼\n\n[Mutation](#mutation) 🔼\n\n[Session Client« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client)[Store IconsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.store-icons)\n\nSee also\n\n[Vtex.session ClientVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client)[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.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api%23schema-description)\n\n[SessionError](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api%23sessionerror)[SessionSuccess](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api%23sessionsuccess)[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api/docs/apps/vtex.session-client@1.0.5/session-client-graphql-api%23session)\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_315d18ec
|
[
{
"role": "system",
"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 global tokens refinements 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/global-tokens-refinements/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/api-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/global-tokens-refinements/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/global-tokens-refinements/docs/storefront-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/global-tokens-refinements/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/global-tokens-refinements/docs/troubleshooting)\n\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/global-tokens-refinements/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/global-tokens-refinements/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/global-tokens-refinements/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/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/global-tokens-refinements/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/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/global-tokens-refinements/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-overview)\n\n[Colors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-colors)\n\n[Grid and Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-grid-and-layout)\n\n[Interactive controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-interactive-controls)\n\n[Refinements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-refinements)\n\n[Spacing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-spacing)\n\n[Typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-typography)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/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/global-tokens-refinements/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/global-tokens-refinements/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/global-tokens-refinements/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/global-tokens-refinements/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/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/global-tokens-refinements/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/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/global-tokens-refinements/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/global-tokens-refinements/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/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/global-tokens-refinements/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/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/global-tokens-refinements/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-overview)\n\n[Colors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-colors)\n\n[Grid and Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-grid-and-layout)\n\n[Interactive controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-interactive-controls)\n\n[Refinements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-refinements)\n\n[Spacing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-spacing)\n\n[Typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-typography)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/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/global-tokens-refinements/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/global-tokens-refinements/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/global-tokens-refinements/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/global-tokens-refinements/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/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/global-tokens-refinements/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/styling-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-overview)\n\nRefinements\n\n`Transition`, `Borders` and `Shadow` definitions.\n\n`Transition`, `Borders` and `Shadow` definitions.\n\n## Transition\n\n| Global Token | Value |\n| ------------------------- | ----------- |\n| \\--fs-transition-timing | .2s |\n| \\--fs-transition-property | all |\n| \\--fs-transition-function | ease-in-out |\n\n## Borders\n\n| Global Token | Value |\n| --------------------------------- | ------------------------- |\n| \\--fs-border-radius-small | 1px |\n| \\--fs-border-radius | 2px |\n| \\--fs-border-radius-medium | 8px |\n| \\--fs-border-radius-pill | 100px |\n| \\--fs-border-radius-circle | 100% |\n| \\--fs-border-width | 1px |\n| \\--fs-border-width-thick | 2px |\n| \\--fs-border-width-thickest | 3px |\n| \\--fs-border-color | var(--fs-color-neutral-4) |\n| \\--fs-border-color-hover | var(--fs-color-main-3) |\n| \\--fs-border-color-active | var(--fs-color-main-2) |\n| \\--fs-border-color-disabled | var(--fs-color-neutral-6) |\n| \\--fs-border-color-light | var(--fs-color-neutral-2) |\n| \\--fs-border-color-light-hover | var(--fs-color-neutral-3) |\n| \\--fs-border-color-light-active | var(--fs-color-neutral-3) |\n| \\--fs-border-color-light-disabled | var(--fs-color-neutral-5) |\n\n## Shadow\n\n| Local token | Default value/Global token linked |\n| ------------------- | --------------------------------- |\n| \\--fs-shadow | none |\n| \\--fs-shadow-darker | 0 0 10px rgb(0 0 0 / 20%) |\n| \\--fs-shadow-hover | 0 0 0 1px var(--fs-color-main-4) |\n\n## Logo\n\n| Local token | Default value/Global token linked |\n| ---------------- | --------------------------------- |\n| \\--fs-logo-width | 7rem |\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/global-tokens/refinements.mdx)\n\n[Interactive controls« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-interactive-controls)[SpacingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-spacing)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Transition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-refinements%23transition)\n\n[Borders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-refinements%23borders)\n\n[Shadow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-refinements%23shadow)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-refinements%23logo)\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/global-tokens/refinements.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Transition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-refinements%23transition)\n\n[Borders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-refinements%23borders)\n\n[Shadow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-refinements%23shadow)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-refinements/docs/guides/faststore/global-tokens-refinements%23logo)\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_84420c1f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore api extensions consuming api extensions in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-overview)\n\nConsuming FastStore API extension with custom components\n\nIn this guide, learn how to consume new fields from [custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) and [overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-consuming-api-extensions).\n\nFastStore extends its capabilities through API Extensions, which provide additional data for customization. This guide focuses on using different hooks to access and manipulate data based on the page type or section you are working with.\n\n## Hooks for consuming API extension data\n\nFastStore exposes the data from both the FastStore API and FastStore API Extensions within a provider. The data is provided as a `context` within the provider, and specific hooks are available for different scenarios:\n\n`usePDP()`: Use this hook when integrating your section with a Product Detail Page (PDP).\n\ncopy\n\n`1\n\nimport { usePDP } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePDP() \n\n`\n\n`usePLP()`: Use this hook when integrating your section with a Product Listing Page (PLP).\n\n`1\n\nimport { usePLP } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePLP() \n\n`\n\n`useSearchPage()`: Use this hook when integrating your section on the Search Page.\n\n`1\n\nimport { useSearchPage } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = useSearchPage() \n\n`\n\n`usePage()`: Use this hook when a single section is used in more than one page type.\n\n`1\n\nimport { usePage } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePage() \n\n`\n\nThis hook returns one of the following context types: `PDPContext`, `PLPContext`, or `SearchPageContext`. You can decide how to handle it depending on the page using this hook by passing these types as generics.\n\n`1\n\nimport { usePage } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePage<PLPContext | SearchPageContext>() \n\n`\n\nAlso, you can use type assertion functions to leverage Typescript and get the correct types.\n\n`1\n\nimport { isPDP, isPLP, isSearchPage } from \"@faststore/core\"; \n\n2\n\n \n3\n\nconst context = usePage() \n\n4\n\n \n5\n\nisPDP(context) \n\n6\n\nisPLP(context) \n\n7\n\nisSearchPage(context) \n\n`\n\n## Consuming API Extensions data from custom sections\n\nTo illustrate how to consume API extension data from custom sections, let's consider a practical example using the **Call To Action** section within a PLP. Make sure you have followed the steps described in the [Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) guide.\n\n1. Create a new section as explained in the [Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) guide.\n2. Import the `usePLP` hook in the component file (`src/components/CallToAction.tsx`) to access data related to PLPs:\n\nsrc/components/CallToAction.tsx\n\n`1\n\nimport { usePLP } from \"@faststore/core\"; \n\n`\n\n1. Inside the component, call the `usePLP` hook to get the context data related to Product Listing Pages. The result is stored in the `context` variable.\n\n`` 1\n\nexport interface CallToActionProps { \n\n2\n\n title: string \n\n3\n\n link: { \n\n4\n\n text: string \n\n5\n\n url: string \n\n6\n\n } \n\n7\n\n} \n\n8\n\n \n9\n\nexport default function CallToAction(props: CallToActionProps) { \n\n10\n\n const context = usePLP() \n\n11\n\n return ( \n\n12\n\n <section> \n\n13\n\n <h2>{`${props.title} ${context?.data?.namedExtraData?.data}`}</h2> \n\n14\n\n </section> \n\n15\n\n ) \n\n ``\n\nNow, you can use the data from `context` as needed. In the provided example, the component returns a `<section>` element containing an `<h2>` element, which combines the `title` prop from the component's props with the data extracted from the context. The optional chaining ensures safe navigation through properties that may be undefined or null. Feel free to customize this approach to suit your needs and leverage the retrieved data for your desired functionality.\n\n## Consuming API Extensions data from custom components in section overrides\n\nAfter [overriding native components and props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overriding-components-and-props%23overriding-a-native-component), you can extend your customization by using hooks within custom components to consume custom data, similar to [custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-consuming-api-extensions%23consuming-api-extensions-data-from-custom-sections). In the following example, the `CustomBuyButton` component overrides the native `BuyButton` component from the `ProductDetails` section inside the Product Details Page (PDP).\n\n1. Open the component file and import the `usePDP` hook from `@faststore/core`.\n2. Use the `usePDP` hook to obtain the context specific to the PDP, which contains relevant information about the product displayed on the page.\n\nsrc/components/CustomBuyButton.tsx\n\n`1\n\nimport { Button as UIButton } from '@faststore/ui' \n\n2\n\nimport { usePDP } from \"@faststore/core\" \n\n3\n\n \n4\n\nexport function CustomBuyButton(props) { \n\n5\n\n const context = usePDP() \n\n6\n\n \n7\n\n return ( \n\n8\n\n <UIButton \n\n9\n\n variant=\"primary\" \n\n10\n\n onClick={() => { \n\n11\n\n alert('Hello User!') \n\n12\n\n }} \n\n13\n\n > \n\n14\n\n {context?.data?.product.customData} \n\n15\n\n </UIButton> \n\n16\n\n ) \n\n17\n\n} \n\n`\n\nIn this scenario, the `CustomBuyButton` component leverages the `usePDP` hook to access the PDP-specific context. It seamlessly integrates with the `UIButton` component from the FastStore UI library, overriding the default behavior of the native `BuyButton` within the `ProductDetails` section. The content displayed within the button, dynamically retrieves and displays custom data associated with the product from the PDP context. The optional chaining ensures safe navigation through properties that may be undefined or null.\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/api-extensions/consuming-api-extensions.mdx)\n\n[Extending queries using fragments« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-extending-queries-using-fragments)[Best practices for using API extensionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-best-practices)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Hooks for consuming API extension data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-consuming-api-extensions%23hooks-for-consuming-api-extension-data)\n\n[Consuming API Extensions data from custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-consuming-api-extensions%23consuming-api-extensions-data-from-custom-sections)\n\n[Consuming API Extensions data from custom components in section overrides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-consuming-api-extensions%23consuming-api-extensions-data-from-custom-components-in-section-overrides)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/api-extensions/consuming-api-extensions.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Hooks for consuming API extension data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-consuming-api-extensions%23hooks-for-consuming-api-extension-data)\n\n[Consuming API Extensions data from custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-consuming-api-extensions%23consuming-api-extensions-data-from-custom-sections)\n\n[Consuming API Extensions data from custom components in section overrides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions/docs/guides/faststore/api-extensions-consuming-api-extensions%23consuming-api-extensions-data-from-custom-components-in-section-overrides)\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_34f693a1
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides erp integration set up order integration in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides)\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-guide)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration)\n\nSet up order integration\n\nIn this step, you will send your orders from VTEX to your ERP or WMS.\n\n## Before you begin\n\nAfter an order is placed in a VTEX store, it follows a predefined [order flow](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/order-flow-on-the-oms--tutorials%5F196) in our Order Management System (OMS). Each [status](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/order-flow-on-the-oms--tutorials%5F196%23understanding-the-status) has a meaning and specified behavior.\n\nThere are two ways to track order status changes on VTEX: [Feed or Hook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed). The feed provides an endpoint you can call to check for status changes, while the hook notifies an endpoint provided by the user whenever there is an order update.\n\nThe order integration process using the order feed is illustrated in the diagram below.\n\n\n\nSee this [boilerplate implementation of an order feed consumer in C#](https://read.calvincode.net/reader?url=https://github.com/vtex/FeedConsumerCSharp) to get you started. If you would like a conceptual overview of our Order Management module, see this [beginner article series](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/orders--2xkTisx4SXOWXQel8Jg8sa) in our Help Center. You can learn more about the order feed [here](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed).\n\n## Configuring the order feed\n\nBefore using the order feed to track status changes, you should configure the filtering rule applied to it using the [Update feed configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/feed/config) endpoint in the Orders API. You can use the [Get feed configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/feed/config) endpoint to check the current feed configuration at any time.\n\n### Filter\n\nThe feed configuration filters the types of order updates that generate events in the queue. This allows you to select the exact types of updates relevant to your integration. The feed can be filtered by changes in status (`”type”: “FromWorkflow”`) or by any changes made to the order's JSON document (`”type”: “FromOrders”`).\n\nWhen filtering changes in status (`”type”: “FromWorkflow”`) for ERP integrations, `ready-for-handling` is probably the most important to monitor. `start-handling` and `handling` may also be relevant depending on the architecture of your operation. For marketplaces with third-party fulfillment, `cancelation-request` and `waiting-ffmt-authorization` may also be important.\n\nThe other filtering type (`”type”: “FromOrders”`) can also be used to filter changes in status or any other change made to an order, which provides a more customizable option. You can, for example, filter orders that have been delivered or had items removed or added to by the store.\n\nLearn more about how to configure filtering options in this [Feed API guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed).\n\n> The order feed is unique to each `appKey` / `appToken` so that it can be configured and used by different applications without interfering with each other.\n\n> The feed configuration does not validate the inserted values. Make sure the elements in the `filter.status` array follow the spelling of the [OMS workflow strings](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196) exactly.\n\n## Getting feed items\n\nTo get a batch of events from the order feed, you should use the [Retrieve feed items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/feed) endpoint in the Orders API. For each event listed, you should determine whether any action is needed by your middleware, depending on the status.\n\n> While the order feed is guaranteed to deliver all order status changes, it does not ensure all events are unique. Make sure your middleware is ready to handle duplicate events.\n\n## Committing feed items\n\nTo acknowledge an event from the order feed, you should use the [Commit feed items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/feed) endpoint in the Orders API. This endpoint receives a list of handles corresponding to the events you acknowledge as received. This action removes the event from the feed.\n\n> You should commit every status change, even if there is no action taken. Failing to do so will block you from receiving the other events in the feed.\n\n> Committed or not, all events are automatically excluded from the feed after 4 days. To avoid losing data, your middleware should run continuously.\n\n## Getting order details\n\nIf an action is required on a specific order due to its current status, you should 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-) endpoint in the Orders API to get all order details (products, payments, delivery, and customer information). The `orderId` can be obtained from the feed event.\n\nIn general, an ERP middleware would take action when the status is `ready-for-handling` by retrieving the order details to send to the ERP. However, other actions can be taken in advanced scenarios, such as notifying your logistics operator when an order is `replaced` or `canceled`.\n\n## Start handling order\n\nAfter the order details have been successfully submitted to the ERP, the final step is to change the order status to `start-handling`. This should only be done once, using the [Start handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/start-handling) endpoint in the Orders API, to start the order processing step.\n\n## Example\n\nImagine a simple integration scenario in which a store configured a feed to filter only by the `ready-for-handling` status. This is the expected chain of events for a given order:\n\n1. In a periodical [Retrieve feed items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/feed) request, the implementation receives an update like this: \n`1 \n[ \n2 \n { \n3 \n \"eventId\": \"ED423DDED4C1AE580CADAC1A4D02DA3F\", \n4 \n \"handle\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR ...\", \n5 \n \"domain\": \"Fulfillment\", \n6 \n \"state\": \"ready-for-handling\", \n7 \n \"lastState\": \"window-to-cancel\", \n8 \n \"orderId\": \"953712004126-01\", \n9 \n \"lastChange\": \"2019-08-12T20:54:01.134057Z\", \n10 \n \"currentChange\": \"2019-08-12T20:54:23.7153839Z\" \n11 \n } \n12 \n] \n`\n2. Since the order is now `ready-for-handling`, the implementation uses the `orderId` from the event to get more information about that order using the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) API call.\n3. With that information, it can send relevant data to the ERP, such as which products and quantities should be shipped.\n4. Now that the appropriate action has been taken, the implementation may acknowledge to the feed that this specific item was read, passing its `handle` in a [Commit feed items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/feed) request.\n5. Finally, the implementation should update the order status to `start-handling` with the [Start handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/start-handling) endpoint in the Orders API.\n\n> This is a basic example of a typical order feed ERP integration. More complex cases are possible. For example, you can monitor different types of updates and trigger different actions for each.\n\n## Wrapping up\n\nTo learn more, check our [ERP integration FAQ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration).\n\nSee also the [Feed v3 API guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed) and check the order [Feed v3 API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/feed/config).\n\n> You can also use a hook to build a reactive order integration, as opposed to a feed, where the integration must actively retrieve events from the queue. To learn more about Hook and which type of integration is best for you, read the [Feed v3 API guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed).\n\nContributors\n\n5\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/theervilha)\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/Integration-Guides/erp-integration-guide/erp-integration-set-up-order-integration.md)\n\n[Import customer data« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration//docs/guides/import-customer-data)[Import productsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration//docs/guides/erp-integration-import-products)\n\nContributors\n\n5\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/theervilha)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23before-you-begin)\n\n[Configuring the order feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23configuring-the-order-feed)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23filter)\n\n[Getting feed items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23getting-feed-items)\n\n[Committing feed items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23committing-feed-items)\n\n[Getting order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23getting-order-details)\n\n[Start handling order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23start-handling-order)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23example)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23wrapping-up)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/erp-integration-set-up-order-integration.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23before-you-begin)\n\n[Configuring the order feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23configuring-the-order-feed)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23filter)\n\n[Getting feed items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23getting-feed-items)\n\n[Committing feed items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23committing-feed-items)\n\n[Getting order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23getting-order-details)\n\n[Start handling order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23start-handling-order)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23example)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration/docs/guides/erp-integration-set-up-order-integration%23wrapping-up)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_af9fc840
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore seo optimizing seo by managing lazy loading on plp and pdp in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-overview)\n\n[Configuring SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp)\n\n[Optimizing SEO by managing lazy loading on PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp)\n\n[Validating UTM tracking in FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-validating-utm-tracking-in-faststore)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-overview)\n\n[Configuring SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp)\n\n[Optimizing SEO by managing lazy loading on PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp)\n\n[Validating UTM tracking in FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-validating-utm-tracking-in-faststore)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-overview)\n\nOptimizing SEO by managing lazy loading on PLPs and PDPs\n\nLazy loading is a method that delays the loading of non-essential resources, such as images or sections of a page, until they are actually needed. FastStore uses lazy loading for all native store sections that are out of the viewport. Each section is wrapped in a component that checks if it is within the viewport. Otherwise, the section is loaded lazily.\n\nThis approach reduces initial page load time and improves the browsing experience, especially on slower devices and networks. However, since sections outside the viewport are not included in the initial HTML, there can be SEO implications, such as search engines not indexing them immediately.\n\nThis guide explains how to manage lazy loading for custom sections to balance SEO and performance.\n\n> Disabling lazy loading will most likely increase initial page load time. Apply this practice only to critical, above-the-fold content or SEO-relevant sections that must render on the initial page load. For guidance, see [Key concepts before implementation](#key-concepts-before-implementation) and [Deciding when to lazy load](#step-1--deciding-when-to-lazy-load).\n\n## Key concepts before implementation\n\nLazy loading in FastStore relies on two complementary building blocks:\n\n* `LazyLoadingSection`: A React wrapper that delays the rendering of content (e.g., blocks) and hydration of non-critical blocks until the content and non-critical blocks approach the viewport.\n* `ViewportObserver`: A utility that detects when content is approaching the viewport and triggers the `LazyLoadingSection` to render the content.\n\nTogether, these two components help reduce initial page load time by delaying rendering, hydration, and resource fetching until content is near the viewport. This is especially useful for users on slower devices and networks.\n\nYes\n\nNo\n\nYes\n\nUser loads page\n\nIs section critical or above the fold?\n\nSection is server-rendered\n\nSection is wrapped with LazyLoadingSection\n\nViewportObserver detects section approaching view\n\nSection is rendered and hydrated\n\nContent becomes visible to user\n\nContent visible to user and search engines\n\n### Server-Side Rendering (SSR) and lazy loading\n\nServer-side rendering provides crucial HTML in the initial document, allowing users and crawlers to access content without executing JavaScript. **Sections wrapped with lazy loading are not included in this initial HTML.** They are only rendered and hydrated when the sections are near the viewport.\n\nFor PDP and PLP templates, you can add the **Skip lazy loading** flag to a custom section to disable lazy loading for that section only. With lazy loading disabled, bots can access the content immediately without scrolling or executing scripts, which may speed up the crawling process.\n\n\n\n### SEO and performance trade-off\n\nSearch engines, such as Google, use crawlers to find and index web content. Although modern crawlers can run JavaScript to render pages, this process can be slow or incomplete. Therefore, it is important to ensure that key commerce content is included in the initial HTML so that it is indexed.\n\nLazy loading can improve Largest Contentful Paint (LCP) and Interaction to Next Paint (INP), which are important SEO ranking factors. By deferring heavy resources, lazy loading helps improve:\n\n* **LCP:** By prioritizing the hero image and other above-the-fold content, the main content loads quickly.\n* **INP:** Deferring heavy JavaScript reduces main-thread contention, making the page more responsive.\n\nOn the other hand, rendering all content upfront can speed up discovery for crawlers, but it can also consume crawl budget, slow down the indexing of other pages on your site, and negatively impact user-perceived performance due to the increased initial payload size.\n\n## Before you begin\n\n### Update the `@faststore/cli` package\n\nMake sure the `@faststore/cli` package is updated to the latest version. To update it, follow the instructions in [Updating the @faststore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version).\n\n### Configure SEO for PLPs and PDPs\n\nSet up title and description templates in the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file to dynamically generate metadata for PLPs and PDPs, such as collections, categories, subcategories, or brands. For instructions, see the [Configuring SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp) guide.\n\n## Instructions\n\n### Step 1: Deciding when to lazy load\n\nLazy loading should be used strategically to ensure that crawlers can access critical content without unnecessary overhead. When essential information is missing from the initial HTML, search engines may be forced to execute JavaScript, such as rendering PLP product grids, which increases crawl budget usage.\n\nBecause of these trade-offs, deciding when to apply or skip lazy loading requires weighing SEO impact, performance goals, and user experience.\n\n#### When to use lazy loading\n\n| Context | Benefit | Example |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **To load content that isn't immediately visible** | Improves initial page load speed by delaying non-critical assets that are below the fold. | A homepage with promotional banners and lookbooks that load as the user scrolls down the page. |\n| **To improve page speed for a media-heavy page** | Optimizes resource usage and ensures the most important content is prioritized and loads first. | A PDP includes a \"Complete the Look\" carousel at the bottom. Since this is a supplementary suggestion, lazy loading ensures the main product details are prioritized and the carousel images load only when the user scrolls to that section. |\n| **The content doesn't affect SEO or crawling** | It will not negatively impact search engine visibility since the content isn't critical for SEO or structured data. | A store's homepage has a \"Fashion Trends\" slider in the footer with inspirational videos. Since this content does not impact structured data for SEO, lazy loading it will not negatively affect search engine visibility. |\n| **To balance server load during high traffic** | It reduces server spikes by loading only the images visible on the screen, keeping the browsing experience fast. | Category pages like \"Dresses\" or \"Jeans\" may have hundreds of product image previews. With lazy loading, only the images visible above the fold load immediately, which reduces server spikes and keeps the browsing experience fast. |\n\n#### When not to use lazy loading\n\n| Context | Reason to avoid | Example |\n| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Hiding critical page elements from crawlers** | Search engines might not see all content if it is lazy-loaded, potentially harming your site's SEO. | A \"New Arrivals\" grid on your homepage displays featured items from several categories. Lazy loading is skipped here to ensure search engines can index all new products shown in this grid. |\n| **Disabling lazy loading globally** | Apply lazy loading selectively. Rendering everything upfront increases payloads, exhausts crawl budget, and slows indexing. | A homepage with numerous campaign images should lazy load secondary media while keeping critical content immediately available. |\n\n### Step 2: Controlling lazy loading for custom sections\n\nFastStore lazy-loads sections to improve store performance. However, some [custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section), such as those containing H1 headers, may need to appear in the initial HTML for SEO purposes. To disable lazy loading for these sections, consider the following:\n\n1. Open the `cms/faststore/sections.json` file in your project.\n2. Locate your custom section in the file, add the `skipLazyLoadingSection` property, and set it to `true`. For example, if your custom section is named `CustomSEOSection`, the configuration would look like this: \n`1 \n... \n2 \n{ \n3 \n \"name\": \"CustomSEOSection\", \n4 \n \"schema\": { \n5 \n \"title\": \"SEO Section\", \n6 \n \"description\": \"Custom H1 configuration\", \n7 \n \"type\": \"object\", \n8 \n \"required\": [\"skipLazyLoadingSection\"], \n9 \n \"properties\": { \n10 \n \"skipLazyLoadingSection\": { \n11 \n \"title\": \"Skip lazy loading\", \n12 \n \"type\": \"boolean\", \n13 \n \"default\": true \n14 \n } \n15 \n } \n16 \n } \n17 \n} \n`\n\nEnabling this feature ensures that the section's content is included in the initial, server-rendered HTML (i.e., lazy loading is skipped for that section).\n\n1. To display PLP data (e.g., collection names) in a custom section, use the [usePLP()](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-consuming-api-extensions%23consuming-api-extensions-data-from-custom-sections) hook. For PDP data (e.g., product titles), use the [usePDP()](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-consuming-api-extensions%23hooks-for-consuming-api-extension-data) hook.\n`usePLP()` hook\n\n`1\n\nimport { usePLP } from \"@faststore/core\"; \n\n2\n\n \n3\n\nexport default function CustomPLPName() { \n\n4\n\n const context = usePLP(); \n\n5\n\n \n6\n\n return ( \n\n7\n\n <section> \n\n8\n\n <h1>Testing - {context.data?.collection?.seo?.title ?? \"PLP\"}!</h1> \n\n9\n\n </section> \n\n10\n\n ); \n\n11\n\n} \n\n`\n\n`usePDP()` hook\n\n`1\n\nimport { usePDP } from \"@faststore/core\"; \n\n2\n\n \n3\n\nexport default function CustomPDPName() { \n\n4\n\n const context = usePDP(); \n\n5\n\n \n6\n\n return ( \n\n7\n\n <section> \n\n8\n\n <h1>Testing - {context.data?.product?.seo?.title ?? \"PDP\"}!</h1> \n\n9\n\n </section> \n\n10\n\n ); \n\n11\n\n} \n\n`\n\n### Step 3: Sending the changes to the Headless CMS\n\n1. Open the terminal and run `yarn cms-sync` to synchronize your local changes with the Headless CMS.\n2. Go to the VTEX Admin and access **Storefront > Headless CMS**.\n3. Access the **Product List Page** or **Product Details Page** Content Type. For this example, we will use the **Product List Page** Content Type. \n> Repeat these steps for the **Product Details Page** Content Type if you are optimizing a PDP section.\n4. Add the custom section you created. The **Skip lazy loading** option will appear at the end of the section. \n\n5. Click `Save` and publish the changes you made.\n6. Click `Preview`.\n7. Search for a collection name to see the new section. For example, if you have a collection named \"Just Arrived,\" you can view it by adding its slug to your store's URL (e.g., `https://mystore.vtex.app/just-arrived`). You will see something similar to the following: \n \n**PDP example** \nFor PDPs, test with a product URL (e.g., `https://mystore.vtex.app/p/blue-shirt`). The image below shows the **New Arrivals** title on the PDP.\n\n### Step 4: Checking if the custom section is visible to search engines\n\nTo ensure that the custom section is present in the initial HTML response, follow these steps:\n\n1. In the browser, right-click anywhere on the page and select **Inspect** from the context menu.\n2. In the **Developer Tools** panel, click the **Network** tab. Ensure that the **All filter** is selected. \n> To focus only on the main HTML document, you can filter by **Doc** in the filter bar. This will show only the initial HTML request, making it easier to inspect the page's source code.\n3. Reload the page while the Developer Tools are open. This will capture all network requests made during the page load.\n4. In the **Name** column of the **Network** tab, look for the request corresponding to the page you are inspecting. In our example, this would be `just-arrived`.\n5. Click the **Response** tab in this panel.\n6. If the section is in the initial HTML response, you will see the corresponding HTML code in the **Response** tab. For example: \n\n\nIf the section is in the initial HTML, as in the example above, it means it is not lazy-loaded and is visible to search engines, confirming it was rendered server-side (lazy loading was skipped).\n\n## Best practices after lazy loading\n\nAfter adjusting lazy loading, monitor its impact and iterate. Focus on measurable outcomes and protect both crawlability and Core Web Vitals.\n\n### Verifying PLP and PDP settings\n\n* PLP server-side HTML: Ensure the category title and first set of product tiles (name, price, primary image) are present in the initial HTML response.\n* PDP server-side HTML: Ensure the product title, price, first image, and variant selector render in the initial HTML.\n* Images: The first visible image should not be lazy-loaded. Use `fetchpriority=\"high\"` on the LCP image when appropriate; add `decoding=\"async\"` and proper `srcset`/`sizes` for responsive images.\n* Placeholders: Reserve space (via `width`/`height` or `aspect-ratio`) for deferred content to prevent CLS.\n* Controls: Filters and sorting that are SEO-relevant should be usable without JavaScript for crawlability (progressive enhancement where feasible).\n\n### Monitoring Core Web Vitals\n\n* Track LCP, INP, and CLS using PageSpeed Insights, Lighthouse, and Search Console's Core Web Vitals report.\n* Identify the LCP element and confirm it is server-rendered and not lazy-loaded; preconnect/preload critical origins/assets when needed.\n* Defer non-critical scripts or schedule them with idle callbacks; move heavy third-party tags out of the initial viewport to protect INP.\n* Use skeletons or low-quality image placeholders (LQIP/blur) for deferred media; ensure reserved space to avoid shifts.\n\n### Analyzing through Google Search Console\n\n* Use URL Inspection > Test Live URL to review the rendered HTML and screenshot of Googlebot's view.\n* Verify critical PLP/PDP content is present in the initial HTML and also visible post-render.\n* Avoid custom attributes for source URLs (e.g., `data-src`). Prefer standard `src` and apply `loading=\"lazy\"` only to below-the-fold images.\n* Monitor Indexing/Coverage and Core Web Vitals (CWV) reports for templates you changed; compare before/after.\n\n### Rollout and verification\n\n* Roll out gradually and compare KPIs (CWV, bounce rate, time to first interaction, indexing) before full deployment.\n* For infinite scroll, expose crawlable pagination or a discoverable \"Load more\" URL pattern to deeper content.\n* In the Developer Tools' Network tab, verify the initial document Response includes the critical PLP/PDP HTML expected by crawlers.\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/faststore/docs/seo/optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp.mdx)\n\n[Configuring SEO for PLPs and PDPs« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp)[Validating UTM tracking in FastStoreNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-validating-utm-tracking-in-faststore)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Key concepts before implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23key-concepts-before-implementation)\n\n[Server-Side Rendering (SSR) and lazy loading](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23server-side-rendering-ssr-and-lazy-loading)[SEO and performance trade-off](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23seo-and-performance-trade-off)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23before-you-begin)\n\n[Update the @faststore/cli package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23update-the-faststorecli-package)[Configure SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23configure-seo-for-plps-and-pdps)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23instructions)\n\n[Step 1: Deciding when to lazy load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23step-1-deciding-when-to-lazy-load)[Step 2: Controlling lazy loading for custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23step-2-controlling-lazy-loading-for-custom-sections)[Step 3: Sending the changes to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23step-3-sending-the-changes-to-the-headless-cms)[Step 4: Checking if the custom section is visible to search engines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23step-4-checking-if-the-custom-section-is-visible-to-search-engines)\n\n[Best practices after lazy loading](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23best-practices-after-lazy-loading)\n\n[Verifying PLP and PDP settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23verifying-plp-and-pdp-settings)[Monitoring Core Web Vitals](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23monitoring-core-web-vitals)[Analyzing through Google Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23analyzing-through-google-search-console)[Rollout and verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23rollout-and-verification)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/seo/optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Key concepts before implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23key-concepts-before-implementation)\n\n[Server-Side Rendering (SSR) and lazy loading](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23server-side-rendering-ssr-and-lazy-loading)[SEO and performance trade-off](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23seo-and-performance-trade-off)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23before-you-begin)\n\n[Update the @faststore/cli package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23update-the-faststorecli-package)[Configure SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23configure-seo-for-plps-and-pdps)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23instructions)\n\n[Step 1: Deciding when to lazy load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23step-1-deciding-when-to-lazy-load)[Step 2: Controlling lazy loading for custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23step-2-controlling-lazy-loading-for-custom-sections)[Step 3: Sending the changes to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23step-3-sending-the-changes-to-the-headless-cms)[Step 4: Checking if the custom section is visible to search engines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23step-4-checking-if-the-custom-section-is-visible-to-search-engines)\n\n[Best practices after lazy loading](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23best-practices-after-lazy-loading)\n\n[Verifying PLP and PDP settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23verifying-plp-and-pdp-settings)[Monitoring Core Web Vitals](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23monitoring-core-web-vitals)[Analyzing through Google Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23analyzing-through-google-search-console)[Rollout and verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp%23rollout-and-verification)\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_a4ba38c0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides storefront 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/storefront-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/storefront-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/storefront-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/storefront-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/storefront-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/storefront-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/storefront-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/storefront-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/storefront-best-practices/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-performance)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-seo)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-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/storefront-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/storefront-best-practices/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-performance)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-seo)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/storefront-development)\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-best-practices)\n\nStorefront best practices\n\nLearn how to optimize your VTEX storefront by following best practices.\n\nTo maintain a high-performing website, you should follow best practices when developing your storefront. By implementing effective strategies, you can create a seamless shopping journey that attracts and retains customers.\n\nThe guides in this section explore key guidelines related to the main factors that influence the competitiveness of your ecommerce site:\n\n* **Accessibility:** Make your store accessible to all users, including those with disabilities.\n* **Analytics:** Leverage data-driven insights to understand customer behavior and make informed decisions.\n* **Performance:** Optimize your website by ensuring fast load times, minimizing slowdowns, and enhancing the overall user experience.\n* **SEO:** Improve your website visibility in search engine results through effective search engine optimization (SEO) practices.\n\n## Guides in this section\n\n[AccessibilityMake sure your store is accessible to all by following these best practices for ecommerce accessibility.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility)[AnalyticsLearn how to leverage data to drive informed decisions and optimize your VTEX store performance.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-analytics)[PerformanceExplore best practices and tools for continuously optimizing website performance.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance)[SEODiscover strategies to improve your ecommerce SEO.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo)\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/storefront-best-practices/storefront-best-practices.md)\n\n[Control to disable the canonical tag« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices//docs/guides/control-to-disable-the-canonical-tag)[AccessibilityNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices//docs/guides/storefront-accessibility)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-best-practices%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/storefront-best-practices/storefront-best-practices.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-best-practices/docs/guides/storefront-best-practices%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_38ef08db
|
[
{
"role": "system",
"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 ProductSummaryBrand 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/ProductSummaryBrand/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/ProductSummaryBrand/docs/api-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/ProductSummaryBrand/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/ProductSummaryBrand/docs/storefront-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/ProductSummaryBrand/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/ProductSummaryBrand/docs/troubleshooting)\n\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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/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/ProductSummaryBrand/docs/vtex-io-apps)\n\nProduct Summary Brand\n\n[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)\n\nVersion: 2.91.0\n\nLatest version: 2.91.0\n\n\n\n> The Product Summary Brand block has been deprecated in favor of the [Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-productbrand) app from the [Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/store-components) collection. Although support for this block is still granted, we strongly recommend updating your store theme with the Product Brand block.\n\nProduct Summary Brand 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 brand of the product.\n\n\n\n## Before you start\n\nEnsure that you have registered [brands](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-brand--QU07yhHoaWcEYseEucOQW) in your store. To do so, follow the [How to register brands](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/registering-brands--tutorials%5F1414) guide.\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-brand` block to your store theme 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-brand\", \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\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/ProductSummaryBrand/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[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBrand/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBrand%23before-you-start)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBrand/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBrand%23configuration)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b109fdee
|
[
{
"role": "system",
"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 performing ab testing between legacy and 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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-io/docs/guides/ab-tests)\n\n[Running A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-running-native-ab-testing)\n\n[A/B testing Legacy and IO store versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-io/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-io/docs/guides/ab-tests)\n\n[Running A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-running-native-ab-testing)\n\n[A/B testing Legacy and IO store versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-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-performing-ab-testing-between-legacy-and-io/docs/app-development)\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/ab-tests)\n\n[A/B testing Legacy and IO store versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io)\n\nA/B testing Legacy and IO store versions\n\nIn this guide, you'll learn how to perform A/B testing between your Legacy CMS store and your Store Framework store. This test helps you determine which workspace delivers the highest conversion rate for your store.\n\nThe A/B test compares two versions of your store: the live Legacy CMS store in the `master` workspace and the Store Framework store in the `production` workspace, capable of receiving user traffic but not yet live.\n\nLegacy CMS store\n\nmaster Workspace\n\nA/B Test\n\nStore Framework store\n\nproduction Workspace\n\nWinner workspace\n\n## Before you begin\n\n* **Install the VTEX IO CLI:** The CLI allows you to log in to your VTEX account, manage workspaces, and develop new apps. For installation instructions, refer to the [Installing 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) guide.\n* **Have a Store Framework theme ready:** Ensure that you have a Store Framework theme ready for your store. If you haven't started building with Store Framework yet, follow the [Storefront track](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) for step-by-step guidance on creating your store from scratch.\n* **Verify your Edition App version:** Confirm that your `development` workspace has the `vtex.edition-store@5.x` Edition app installed by running `vtex edition get` in your terminal. If it's not installed, [open a ticket with the VTEX support team](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk?%5Fga=2.222513819.1487123273.1647865109-1001456323.1619912759) to request its installation in the new Development workspace.\n\n## Instructions\n\n### Step 1 - Setting up the Legacy CMS\n\nAfter creating your Store Framework theme and making changes in your `development` workspace, set up the Legacy CMS environment to conduct the test. This setup allows you to evaluate your changes with real user traffic.\n\n1. [Create a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace) to test your changes with some user traffic.\n2. Run the `vtex use master` command in your terminal to perform the steps below in the `master` workspace. The `master` workspace must be set to the `vtex.edition-business@0.x` [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app).\n3. Install the `vtex.colossus-legacy-proxy@@1.8.9-hkignore` app by running the following command. This app is responsible for routing requests within the VTEX IO environment during an A/B test between IO and Legacy CMS. \n`1 \nvtex install vtex.colossus-legacy-proxy@@1.8.9-hkignore \n` \n> Ensure the app version is `1.8.9-hkignore`. Using a different version will prevent the store from responding correctly. Note that the `vtex.colossus-legacy-proxy@1.8.9-hkignore` directs traffic to the `master` workspace in Legacy CMS Portal, while the `vtex.colossus-legacy-proxy@2.x` version routes traffic to the VTEX IO workspace.\n\n### Step 2 - Requesting an A/B test\n\nNow that you have set up the Legacy CMS environment for testing, you can request an A/B test. This step lets you compare the performance and user experience between your Legacy CMS environment and the VTEX IO environment, helping you make informed decisions about your store.\n\n1. [Open a ticket with the VTEX support team](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk?%5Fga=2.222513819.1487123273.1647865109-1001456323.1619912759) to request the redirection of the `production` workspace to be rendered in VTEX IO. Please provide the following information in your ticket: \n * Account name \n * `production` workspace \n * Indicate whether the store features a distinct storefront for mobile devices.\n2. Once the `production` workspace is ready, you can configure the A/B test as outlined in the [Running native A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing) guide.\n\n### Step 3 - Validating if the A/B test is running\n\nTo ensure the A/B test is active, send a `GET` request to the following API: `http://platform.io.vtex.com/{{accountName}}/_abtest/parameters`.\n\n> Include the `VtexIdclientAutCookie` header from the account you want to get the information. For example: `VtexIdclientAutCookie: {{VtexIdclientAutCookie}}`\n\nThe response should look something like this, indicating traffic distribution:\n\n`1\n\n\"master\": { \n\n2\n\n \"A\": 9000, \n\n3\n\n \"b\": 1 \n\n4\n\n}, \n\n5\n\n\"wsio\": { \n\n6\n\n \"A\": 1000, \n\n7\n\n \"b\": 1 \n\n8\n\n} \n\n`\n\nThis example shows that the `master` is receiving 90% of the traffic, and the `wsio` workspace is receiving 10%.\n\n### Step 4 - Migrating your changes\n\nAfter completing the A/B test and deciding to migrate your store to Store Framework, [open a ticket to the VTEX support team](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk?%5Fga=2.222513819.1487123273.1647865109-1001456323.1619912759).\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/ab-tests/vtex-io-documentation-performing-ab-testing-between-legacy-and-io.md)\n\n[Running A/B tests« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io//docs/guides/vtex-io-documentation-running-native-ab-testing)[DeploymentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io//docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\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-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23instructions)\n\n[Step 1 - Setting up the Legacy CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23step-1-setting-up-the-legacy-cms)[Step 2 - Requesting an A/B test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23step-2-requesting-an-ab-test)[Step 3 - Validating if the A/B test is running](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23step-3-validating-if-the-ab-test-is-running)[Step 4 - Migrating your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23step-4-migrating-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/App-Guides/ab-tests/vtex-io-documentation-performing-ab-testing-between-legacy-and-io.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-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23instructions)\n\n[Step 1 - Setting up the Legacy CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23step-1-setting-up-the-legacy-cms)[Step 2 - Requesting an A/B test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23step-2-requesting-an-ab-test)[Step 3 - Validating if the A/B test is running](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23step-3-validating-if-the-ab-test-is-running)[Step 4 - Migrating your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io%23step-4-migrating-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_4e471180
|
[
{
"role": "system",
"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 slide over 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-slide-over/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-slide-over/docs/api-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-slide-over/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-slide-over/docs/storefront-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-slide-over/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-slide-over/docs/troubleshooting)\n\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-slide-over/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-slide-over/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-slide-over/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/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-slide-over/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-slide-over/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-slide-over/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/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-slide-over/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/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-slide-over/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/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-slide-over/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-slide-over/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-slide-over/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/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-slide-over/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-slide-over/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-slide-over/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-overview)\n\nSlideOver\n\nRepresents an aditional session that complements the screen's information.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/SlideOver)\n\nThe `SlideOver` component represents an aditional session that complements the screen's information.\n\nExample\n\nCode\n\n**Open Partial**\n\nRight\n\nLeft\n\n**Open Full**\n\nRight\n\nLeft\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { SlideOver, SlideOverHeader } 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/SlideOver/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-slide-over-bkg-color | var(--fs-color-body-bkg) |\n| \\--fs-slide-over-transition-timing | var(--fs-transition-timing) |\n\n### Header\n\n| Local token | Default value/Global token linked |\n| --------------------------------- | ----------------------------------------------------------- |\n| \\--fs-slide-over-header-padding | var(--fs-spacing-2) var(--fs-spacing-3) var(--fs-spacing-2) |\n| \\--fs-slide-over-header-bkg-color | var(--fs-color-neutral-0) |\n\n### Variants\n\n#### Partial\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------- | ---------------------------------------------- |\n| \\--fs-slide-over-partial-gap | calc(2 \\* var(--fs-grid-padding)) |\n| \\--fs-slide-over-partial-width-mobile | calc(100vw - var(--fs-slide-over-partial-gap)) |\n| \\--fs-slide-over-partial-width-notebook | calc(100% / 3) |\n| \\--fs-slide-over-partial-max-width-notebook | calc(var(--fs-grid-breakpoint-notebook) / 3) |\n\n---\n\n## Data attributes\n\nYou can target and override `SlideOver` styles using the following data attributes:\n\n`data-fs-slide-over`\n\n`data-fs-slide-over-size=\"full\" | \"partial\"`\n\n`data-fs-slide-over-state=\"in\" | \"out\"`\n\n`data-fs-slide-over-header`\n\n`data-fs-slide-over-header-icon`\n\n---\n\n## Props\n\n### SlideOver\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-slide-over | | | | | | |\n| **isOpen\\*** | false \\| true | A boolean value that represents the state of the SlideOver | | | | | | | |\n| **direction** | \"leftSide\" \\| \"rightSide\" | Represents the side that the SlideOver comes from. | leftSide | | | | | | |\n| **size** | \"full\" \\| \"partial\" | Represents the size of the SlideOver. | full | | | | | | |\n| **fade** | \"in\" \\| \"out\" | Represents the fade effect of the SlideOver. | out | | | | | | |\n| **children\\*** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Children or function as a children. |\n| **overlayProps** | Props | Props forwarded to the \\`Overlay\\` component. | | | | | | | |\n| **onDismiss** | () => void | This function is called whenever the user clicks outside. the modal content | | | | | | | |\n| **aria-labelledby** | string | Identifies the element (or elements) that labels the current element. @see aria-labelledby https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby | | | | | | | |\n| **onEntered** | () => void | Callback function when the modal is opened. | | | | | | | |\n| **disableEscapeKeyDown** | false \\| true | Disable being closed using the Escape key. | | | | | | | |\n\n### SlideOverHeader\n\n| Name | Type | Description | Default | | | | | | |\n| ----------------- | ----------------------------------------- | --------------------------------------------- | ------- | -- | ------------------------ | --------------------------- | ------------------- | ----------- | -------------------------------------------------------- |\n| **children** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A react component to be used as the title in the header. |\n| **closeBtnProps** | Partial<Omit<IconButtonProps, \"onClick\">> | Props for the Close Button component. | {} | | | | | | |\n| **onClose\\*** | () => void | Function called when Close Button is clicked. | | | | | | | |\n\n---\n\n## Related components\n\n* Open Cart \nCartSidebar \nThe CartSidebar displays the summary of items added to the cart along with detailed information, and checkout option. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-cart-sidebar)\n* Open Filters \nFilterSlider \nThe mobile Filter view that is rendered inside a SlideOver component. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-filter-slider)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\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/slide-over.mdx)\n\n[ShippingSimulation« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-shipping-simulation)[Implementing storefront featuresNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/storefront-features-overview)\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-slide-over/docs/guides/faststore/organisms-slide-over%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23design-tokens)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23header)[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23variants)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23props)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23slideover)[SlideOverHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23slideoverheader)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%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/slide-over.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-slide-over/docs/guides/faststore/organisms-slide-over%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23design-tokens)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23header)[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23variants)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23props)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23slideover)[SlideOverHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%23slideoverheader)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-slide-over/docs/guides/faststore/organisms-slide-over%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_96651db3
|
[
{
"role": "system",
"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 productskuattributes 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-productskuattributes/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-productskuattributes/docs/api-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-productskuattributes/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-productskuattributes/docs/storefront-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-productskuattributes/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-productskuattributes/docs/troubleshooting)\n\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-productskuattributes/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/updates/release-notes)\n\nProduct SKU Attributes\n\nThe `product-sku-attributes` block displays a list of the current SKU variations of a product.\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 `product-sku-attributes` block to any child of the `store.product` template (Product Details Page template). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"product-sku-attributes\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `product-sku-attributes` block using the props stated in the [Props](#props) table. For example:\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n\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| attributeLine |\n| attributeName |\n| attributeValue |\n| ProductSKUAttributesContainer |\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-productskuattributes.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-productskuattributes/docs/guides/vtex-store-components-productskuattributes%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/docs/guides/vtex-store-components-productskuattributes%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/docs/guides/vtex-store-components-productskuattributes%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-productskuattributes.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-productskuattributes/docs/guides/vtex-store-components-productskuattributes%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/docs/guides/vtex-store-components-productskuattributes%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productskuattributes/docs/guides/vtex-store-components-productskuattributes%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_9baa76d7
|
[
{
"role": "system",
"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 overview of vtex io services 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/overview-of-vtex-io-services/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/overview-of-vtex-io-services/docs/api-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/overview-of-vtex-io-services/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/overview-of-vtex-io-services/docs/storefront-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/overview-of-vtex-io-services/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/overview-of-vtex-io-services/docs/troubleshooting)\n\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/overview-of-vtex-io-services/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/overview-of-vtex-io-services/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/overview-of-vtex-io-services/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/overview-of-vtex-io-services/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/overview-of-vtex-io-services/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/overview-of-vtex-io-services/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/overview-of-vtex-io-services/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/overview-of-vtex-io-services/updates/release-notes)\n\nOverview of VTEX IO Services\n\nVTEX IO powers big ecommerce operations, and for most of that it's necessary to **run code on a server**. Services are how we run **Node.js or .NET** code on VTEX IO infrastructure, backed by API abstractions to improve developer experience.\n\nServices can export **HTTP Routes**, **GraphQL resolvers** or **event handlers.**\n\nUsing the builders `node` or `dotnet`, you can export services from a VTEX IO app, just like themes or store blocks. It's easy to quickly setup, for example, a REST API with that.\n\n## The `service.json` file\n\nThe `service.json` is a file that must exist on the folder of the service (`node/` or `dotnet/`), and it's with this file that you may **declare routes or events that the service must respond to.** It also configures parameters like _timeout_ and _memory_ about the deployment of that service.\n\nThis is the `node/service.json` from [vtex.service-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example) app:\n\n`1\n\n{ \n\n2\n\n \"memory\": 256, \n\n3\n\n \"ttl\": 10, \n\n4\n\n \"timeout\": 2, \n\n5\n\n \"minReplicas\": 2, \n\n6\n\n \"maxReplicas\": 4, \n\n7\n\n \"routes\": { \n\n8\n\n \"status\": { \n\n9\n\n \"path\": \"/_v/status/:code\", \n\n10\n\n \"public\": true \n\n11\n\n } \n\n12\n\n } \n\n13\n\n} \n\n`\n\n> After defining these configs, it's possible to export handler functions on node/index.ts file. Most of the fields on the service.json are optional, and default values will be used by the platform. | Name | Type | Description | | --- | --- | --- | | routes | Object | A map from the name of a route handler you want to another object declaring path, public or other information about ReBAC | | events | Object | A map from the name of a event handler on the code to another object describing sender or keys | | memory | Number | In MB. The size of memory to be allocated to that service. | | ttl | Number | In minutes. Time that the platform will keep the service running without receiving any requests. Default: 10\\. Max: 120 | | timeout | Number | In seconds. VTEX IO infra will abort the connection if the request time is longer than that | | minReplicas | Number | When the service is running, how many minimum replicas will be available. | | maxReplicas | Number | The largest amount of replicas that will be available. | | workers | Number | Numbers of workers to spawn for that service on production. (Max: 4) |\n\n> It's also possible to export GraphQL services, using the graphql builder. You can check vtex.graphql-example to see how it's done.\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/back-end-development-concepts/overview-of-vtex-io-services.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[The service.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/overview-of-vtex-io-services/docs/guides/overview-of-vtex-io-services%23the-servicejson-file)\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/back-end-development-concepts/overview-of-vtex-io-services.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[The service.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/overview-of-vtex-io-services/docs/guides/overview-of-vtex-io-services%23the-servicejson-file)\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_397ac6cc
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration product load in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-guide)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load)\n\nGet product list for an initial load\n\nThe initial load of products only occurs after the user installs and configures the connector to use the VTEX Catalog and communicate with the marketplace. All products active on the main account and associated to a sales channel must be sent to the marketplace.\n\n\n\n## Send initial load of products\n\nFollow the steps below, to send the initial load of products in the integration’s flow:\n\n1. Connector validates the VTEX <> Marketplace authentication. In case it has expired, perform the update routine defined in the marketplace’s documentation. Otherwise, connectors should log the error AND put the VTEX notification in a contingency queue.\n2. VTEX Seller informs connector the sales channel’s ID for the integration.\n3. Connector collects the list of SKUs through the Get SKU by sales channel `(api/catalog_system/pvt/sku/stockkeepingunitidsbysaleschannel)` endpoint.\n4. For each SKU retrieved, the connector must: a. Collect details of each SKU through the [Get SKU and Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku-context) endpoint. b. Validate if the SKU is active through the `isActive` property. c. Validate if the SKU is associated to the sales channel used in the intgration through the `salesChannel` property. d. Validate if the product is active through the [Get Product by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-product) endpoint, through the `isActive` property._This step is optional, since the [Get SKU and Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku-context) endpoint already delivers the attribute `IsProductActive` for this purpose_. e. Identify whether the SKU conforms to the marketplace’s product registration rules. f. Validate if the product’s category is mapped in the marketplace. In case it is not mapped, the marketplace should put the SKU in the approval queue, until the [mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper%23post-/api/mkp-category-mapper/categories/marketplace/-id-) is complete. g. For SKUs sent with price and inventory levels set up, the connector should validate whether the SKU has price and inventory levels with the sales channel configured for the integration. This should be done through the [Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) endpoint, without the Postal Code. h. Collect: \n * Inventory level on all available warehouses, through the `logisticsStockBalance` field. \n * Sales price value with applied promotions and discounts, through the `price` field. It is also possible to retrieve the original price through the `listPrice` field.\n\nIf all validations pass, the product or SKU is sent to the marketplace and the operation is logged according to information described in the [Logs made available for users](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs%23log-messages).\n\nIf the IDs between VTEX and the marketplace differ, the connector should store both values. This information will be used for SKU [update](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-product-updates) operations.\n\n> Be mindful to make all validations at once, and before the SKU’s publication in the marketplace’s catalog. In case there’s an error detected, the connector presents the seller a list of actions to correct. This way we can avoid the correct - publish - correct cycle.\n\nIf products do not apply to steps a, b and c, an error log must be filed, and the connector should collect the next items on the list obtained by step 2.\n\n### Recommendations\n\nTo avoid processing gaps due to the big volume of information of the initial load of products, we recommend:\n\n* Using an async messaging architecture, using individual queues by context and store.\n* Creating mechanisms that respect the marketplace API limit rates. We suggest the standard use of the _Circuit Breaker_ integration.\n* In case any of the steps listed above presents failures in communication, we suggest using the contingency mechanism of _deadLetters_.\n* Being TotalReader: whenever possible, in the data transformation process, using standard values accepted by the marketplace, in case the information is not filled or sent by VTEX.\n* In case the marketplace’s processing is in lots - meaning that the connector assembles a group of SKUs, guaranteeing the the limit of records per lot is respected, according to marketplace riles, and sending them to the marketplace at once - it is fundamental to control the lot’s processing, to avoid sending SKU updates without making sure that the product exists in the marketplace.\n* Keeping a states table to know which SKUs have not been integrated with success, attempt date and the response received. This allows the system to use the contingency flow effectively, avoiding infinite loops, and avoiding reaching the request limit.\n\n## API Reference\n\nUse the endpoints described below to get SKU, price and inventory details. It is important to note that when consuming this API, the connector must have a valid VTEX App Key and App Token. You can also [download our Postman collection](https://read.calvincode.net/reader?url=https://www.getpostman.com/collections/95a809929905a50e2b7b) to access the API. The diagram illustrates the endpoints used in the integration:\n\n\n\n[Get list of SKUs associated with a sales channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Fapi-catalog-system-pvt-sku-stockkeepingunitidsbysaleschannel) \n\n[Get details of an SKU associated with a sales channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku)\n\n[Check if product is active](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/productandtradepolicy)\n\n[Simulate price and inventory levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation)\n\n## Scenario 1: First load of products after integration’s activation\n\nAfter configuring the communication with the marketplace, connectors must send the first load of products. For every product retrieved from the SKU list associated with the sales channel, the connector must:\n\n1. Validate category mapping.\n2. Collect skuId ‘s available in the sales channel associated with the marketplace.\n3. [Get SKU information](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku), like weight and dimensions.\n4. Use the [Orderform simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) to get price and inventory level, if needed.\n\nIn case there’s any failures in an item, connectors should log the error, and move on to the next item on the list, until all SKUs are processed.\n\n## Scenario 2: Deactivate products if the integration is deactivated\n\nIf the integration’s deactivation is confirmed with the marketplace, connectors must deactivate products published in the marketplace.\n\n1. [Get SKU information](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku).\n2. Send SKU block or deactivation request.\n3. Exclude SKUs and clean state control of the integration’s SKUs.\n\n> Make sure that all steps are logged as either success or failure, to offer the operation’s full traceability. Check out the [Logs made available for users](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs) page to learn more.\n\n## What VTEX needs to validate the integration flow\n\nTo consider the integration validated by VTEX, the connector should:\n\n1. Follow the step by step of the catalog integration flow.\n2. Create a table with VTEX and marketplace field mapping. It should include limitations, transformations, and required fields.\n3. Create a table that explicits which data is mandatory and which is recommended when registering products or SKUs and to improve the offer’s positioning in the marketplace’s storefront.\n4. Create a table with known error logs and actions that the user can do to solve the problem.\n\n### Template table for field mapping\n\n| VTEX field | How to fill it in VTEX | VTEX API | Marketplace field |\n| ---------- | ---------------------- | --------------------------------- | ----------------- |\n| Name | Catalog page | /api/catalog/pvt/stockkeepingunit | ShortName |\n| Image | Catalog page (SKU) | Images | |\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-product-load.md)\n\n[Catalog logs« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load//docs/guides/external-marketplace-integration-logs)[How to get a new product to offer in the marketplaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load//docs/guides/external-marketplace-integration-new-products)\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[Send initial load of products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23send-initial-load-of-products)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23recommendations)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23api-reference)\n\n[Scenario 1: First load of products after integration’s activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23scenario-1-first-load-of-products-after-integrations-activation)\n\n[Scenario 2: Deactivate products if the integration is deactivated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23scenario-2-deactivate-products-if-the-integration-is-deactivated)\n\n[What VTEX needs to validate the integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23what-vtex-needs-to-validate-the-integration-flow)\n\n[Template table for field mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23template-table-for-field-mapping)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-product-load.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Send initial load of products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23send-initial-load-of-products)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23recommendations)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23api-reference)\n\n[Scenario 1: First load of products after integration’s activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23scenario-1-first-load-of-products-after-integrations-activation)\n\n[Scenario 2: Deactivate products if the integration is deactivated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23scenario-2-deactivate-products-if-the-integration-is-deactivated)\n\n[What VTEX needs to validate the integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23what-vtex-needs-to-validate-the-integration-flow)\n\n[Template table for field mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load/docs/guides/external-marketplace-integration-product-load%23template-table-for-field-mapping)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_7a7f874a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides getting started 3 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/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/getting-started-3/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/getting-started-3/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/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/getting-started-3/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/getting-started-3/docs/guides/store-framework-glossary)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/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/getting-started-3/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/getting-started-3/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/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/getting-started-3/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/getting-started-3/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/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/getting-started-3/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/getting-started-3/docs/guides/store-framework-glossary)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/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/getting-started-3/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/getting-started-3/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/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/getting-started-3/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/store-framework)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/getting-started-3)\n\nStorefront\n\nLearn how to build a Store Theme with VTEX IO and Store Framework from scratch.\n\nThis comprehensive guide will take you through the process of building a Store Theme using VTEX IO and Store Framework.\n\n[Part 1\\. Setting up your development environmentLearn how to configure your development environment to build a Store Theme app with VTEX IO.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-basicsetup)[Part 2\\. Configuring your accountSet up your account Edition to get started with Store Framework.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites)[Part 3\\. Creating a Store Theme projectCreate your very first Store Framework storefront project.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme)[Part 4\\. Configuring templatesDiscover how to manage templates, add or remove blocks, and customize your Store Theme.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates)[Part 5\\. Defining stylesLearn how to set specific styles for your store components to enhance your store's user experience.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles)[Part 6\\. Building your own Store ThemeAccess our hands-on course on Store Framework.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)[Part 7\\. Making your theme content publicFind out how to make your Store Framework theme accessible to end users.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/getting-started-3.md)\n\n[Store Theme« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3//docs/guides/vtex-io-documentation-store-theme)[1\\. Setting up your development environmentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3//docs/guides/vtex-io-documentation-1-basicsetup)\n\nSee also\n\n[1\\. Setting up your development environmentStorefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3/docs/guides/vtex-io-documentation-1-basicsetup)\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/Getting-Started/getting-started-3.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_bc3da662
|
[
{
"role": "system",
"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 google analytics 4 is tracking inconsistent data from my 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/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-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/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-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/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-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/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-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/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-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/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n---\n\nStore performance\n\n[I can't complete a purchase on a FastStore website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website)\n\n[My store is slow or unavailable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/my-store-is-slow-or-unavailable)\n\n[Google Analytics 4 is tracking inconsistent data from my store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store)\n\n[UTMs are not being applied to the cart at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/utms-are-not-being-applied-to-the-cart-at-checkout)\n\n[My routes are not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/my-routes-are-not-behaving-as-expected)\n\n[My store is presenting price inconsistencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/my-store-is-presenting-price-inconsistencies)\n\n[My store translation is not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n---\n\nStore performance\n\n[I can't complete a purchase on a FastStore website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website)\n\n[My store is slow or unavailable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/my-store-is-slow-or-unavailable)\n\n[Google Analytics 4 is tracking inconsistent data from my store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store)\n\n[UTMs are not being applied to the cart at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/utms-are-not-being-applied-to-the-cart-at-checkout)\n\n[My routes are not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/my-routes-are-not-behaving-as-expected)\n\n[My store is presenting price inconsistencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/my-store-is-presenting-price-inconsistencies)\n\n[My store translation is not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected)\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting)\n\nStore performance\n\nGoogle Analytics 4 is tracking inconsistent data from my store\n\nIf Google Analytics 4 is not accurately traciing data, try server-side tagging and configuring a VTEX IO Pixel app.\n\n**Keywords:** GA4 | performance | analytics\n\nAfter configuring [Google Analytics 4 (GA4)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager), your store may experience issues with inconsistent data tracking.\n\nDue to General Data Protection Regulation (GDPR) restrictions, some companies are updating their operating systems, browsers, and devices to block events triggered during shopper navigation, which is the main reason behind this problem.\n\n## Solution\n\nTo solve this problem, follow the instructions below.\n\n### Step 1 - Setting up server-side tagging\n\nServer-side tagging shifts tag processing from the client side to the server environment. This enhances website performance by reducing client-side code, improves data security by managing sensitive information on the server, and provides greater control over data collection.\n\nActing as an intermediary between users and data vendors, server-side tagging enables faster page loads, stronger security policies, better privacy, and more durable cookies, all while using familiar Google Tag Manager tools.\n\nTo configure server-side tagging, follow Google's [Server-Side Tag Manager](https://read.calvincode.net/reader?url=https://developers.google.com/tag-platform/tag-manager/server-side) documentation.\n\n### Step 2 - Creating a VTEX IO Pixel app\n\nFollow the instructions in the [Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps) guide to develop your own Pixel app.\n\nAfter creating the Pixel app, add the Google Tag Manager (GTM) script passing the correct container code and the server URL (which holds the server-side tag manager configuration) that will trigger the events for Google.\n\n### Step 3 - Setting up the native GTM app\n\nKeep the native [GTM app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager) installed in your store, but pass a **fake container code** to the app.\n\nTo access the GTM app settings, go to `https://{accountName}.myvtex.com/admin/apps/vtex.google-tag-manager@3.5.4/setup/`, replacing `{accountName}` with your VTEX account name. In the `Enter the ID (GTM-XXXX) from your Google Tag Manager` field, add the fake container code.\n\n\n\n### Step 4 - Setting up the store checkout\n\nRemove the container code from the store checkout configuration.\n\nGo to `https://{accountName}.myvtex.com/admin/portal/#/sites/default/checkout/`, replacing `{accountName}` with your VTEX account name, to access your store checkout configuration.\n\n\n\nInsert the GTM script with the correct container and the server URL into the JavaScript tab within the [Checkout UI Custom app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom) and click `Publish` to track the events triggered on the store checkout pages.\n\n\n\nThe expected behavior is that your store's analytics data should be consistent and reflect user interactions.\n\nAfter following these steps, if the error continues, open a [support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support).\n\n## Learn more\n\n* [Configuring Google Tag Manager](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/integration-with-google-tag-manager--frequentlyAskedQuestions%5F616)\n* [How to customize the Checkout UI Custom in the Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/how-to-customize-the-checkout-ui-custom-in-the-admin--548aDBJciQu97Vh0BhEiWx)\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/troubleshooting/store-performance/google-analytics-4-is-tracking-inconsistent-data-from-my-store.md)\n\n[My store is slow or unavailable« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/my-store-is-slow-or-unavailable)[UTMs are not being applied to the cart at CheckoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/utms-are-not-being-applied-to-the-cart-at-checkout)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23solution)\n\n[Step 1 - Setting up server-side tagging](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23step-1-setting-up-server-side-tagging)[Step 2 - Creating a VTEX IO Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23step-2-creating-a-vtex-io-pixel-app)[Step 3 - Setting up the native GTM app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23step-3-setting-up-the-native-gtm-app)[Step 4 - Setting up the store checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23step-4-setting-up-the-store-checkout)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23learn-more)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/store-performance/google-analytics-4-is-tracking-inconsistent-data-from-my-store.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23solution)\n\n[Step 1 - Setting up server-side tagging](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23step-1-setting-up-server-side-tagging)[Step 2 - Creating a VTEX IO Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23step-2-creating-a-vtex-io-pixel-app)[Step 3 - Setting up the native GTM app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23step-3-setting-up-the-native-gtm-app)[Step 4 - Setting up the store checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23step-4-setting-up-the-store-checkout)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store%23learn-more)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b555abdb
|
[
{
"role": "system",
"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 8 translating the component in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/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-8-translating-the-component/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/create-master-data-crud-app)\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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/create-master-data-crud-app)\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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/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-8-translating-the-component/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n7\\. Translating the component\n\nBefore thinking about brand globalization, it is very important to first look into **content internationalization on your website**.\n\n**Messages** is the VTEX IO app that translates store components, working directly on block code so that the development cycle is not limited by the necessary versioning flow from one language to another.\n\nOnce implemented in the app, Messages automatically identifies and interprets passive text messages for translation, reducing obstacles in the evolution process of your code–except in cases where you have already entered a customized translation manually.\n\n## Configuring Messages\n\nFor Messages to work as expected, we will use the [react-intl](https://read.calvincode.net/reader?url=https://formatjs.io/docs/react-intl) library. Serving as a translation engine, this highly versatile library has several advanced internationalization features (_i18n_) for your _front_ app.\n\n1. Open your app's code in the code editor of your choice.\n2. Access the `react` folder and then run the command `yarn add react-intl@3 && yarn add @types/react-intl@3 --dev`.\n3. Access the `manifest.json` file and add the `messages` builder to the `builders` list, as shown in the following example:\n\n`1\n\n{ \n\n2\n\n ... \n\n3\n\n \"builders\": { \n\n4\n\n \"react\": \"3.x\", \n\n5\n\n \"docs\": \"0.x\", \n\n6\n\n+ \"messages\": \"1.x\" \n\n7\n\n }, \n\n8\n\n ... \n\n9\n\n} \n\n`\n\n1. Save your code changes.\n\nAll set! Having all the `react-intl` dependencies installed and the Messages [builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/) configured, we can proceed to the next steps.\n\n## Allowing automatic translations\n\nTo understand how VTEX IO translations work in practice, consider the React `HelloWorld` component imported in article 3 of this series:\n\n`1\n\nimport React from 'react' \n\n2\n\n \n3\n\nconst HelloWorld = () => <div>Hello World!</div> \n\n4\n\n \n5\n\nexport default HelloWorld \n\n`\n\nNote that, regardless of the language used on the store page, the `Hello World!` text will be rendered in the component.\n\nIn order to have the `Hello World!` text automatically translated when the page language changes, we have to use the `FormattedMessage` component from the `react-intl` package to specify which strings should be translated into other languages.\n\nAs a parameter for the `FormattedMessage` component, we will have a unique ID (`id`) associated with a specific string declared in your app:\n\n1. Substitute the `HelloWorld` component code with the code below:\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { FormattedMessage } from 'react-intl' \n\n3\n\n \n4\n\nconst HelloWorld = () => { \n\n5\n\n return ( \n\n6\n\n <div> \n\n7\n\n <FormattedMessage id=\"store/my-app.hello\"/> \n\n8\n\n </div> \n\n9\n\n ) \n\n10\n\n} \n\n11\n\n \n12\n\nexport default HelloWorld \n\n`\n\n> Note that in the example above we use the `FormattedMessage` component by associating it to the `\"store/my-app.hello\"` ID, which we created for our example. Since each ID has to be linked to a single string only, it is necessary to define the `FormattedMessage` component in this folder as many times as necessary in accordance with the translatable strings.\n\n> When creating an `id`, consider using the `store/` or `admin/` prefixes (depending on your app's functionality) followed by the app name (`my-app`) and, finally, a short word that can identify this string. For example,`store/my-app.hello`.\n\n1. In your app's root directory, create a `messages` folder.\n2. In the newly created folder, create a new `.json` file named using the ISO code for the desired language. For example: `pt`, `en`, `fr`.\n3. In the desired language file, such as `messages/en.json`, associate the `id` used in the `FormattedMessage` component with the desired string:\n\n`1\n\n{ \n\n2\n\n \"store/my-app.hello\": \"Hello World!\" \n\n3\n\n} \n\n`\n\n1. Save all your code changes.\n\nWhen you [_link_](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/) your app again and change the page language, you will notice that the text `Hello World!` is automatically translated into the UI thanks to the `react-intl` library component and Messages.\n\n> To test these effects in the store linked to your VTEX account, access `https://{workspaceName}-{accountName}.myvtex.com` and add the query string `cultureInfo` with desired language value. For example, to check your page in Brazilian Portuguese type: `https://{workspaceName}-{accountName}.myvtex.com/?cultureInfo=pt-BR`, substituting `{workspaceName}` and `{accountName}` with the development workspace name and your VTEX account name, respectively.\n\n## Overwriting automatic translations\n\nDepending on your business scenario, you may want to change an automatic translation with a customized one.\n\nIn this section, we will teach you how to override Messages’ automatic translations using the same example as before:\n\n1. In the `Messages` folder, access the file you want for the translation language that will be overwritten (`messages/pt.json`, for example).\n2. In this file, define a new translation for the same `id` previously linked to the desired string. For example:\n\n`1\n\n{ \n\n2\n\n \"store/my-app.hello\": \"Olá, pessoal!\" \n\n3\n\n} \n\n`\n\nBy linking the same `id` to another translation, you are telling VTEX IO to ignore Messages’ automatic translation and consider only the one you defined manually.\n\n[_Link_](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/) your app again and change the page language to Portuguese to see how the translation you defined is rendered!\n\n## Advanced translations\n\nInternationalizing a component can mean more than translating its strings. For example, it can include changing price and percentage formatting.\n\nHaving your app's purpose in mind, you can (and should) make some adjustments to the rendered messages when they contain:\n\n* Price representations;\n* Variable values;\n* Gender and number agreement dependencies\n* Percentage representations;\n* Dynamic messages, such as error messages.\n\n### Adjusting price representations\n\nPrice formatting for describing prices varies from country to country. If the app you are developing includes price variables, it is essential to set it up to handle different internationalization scenarios.\n\nTo automate these price changes in the translation flow, you need to add the `vtex.format-currency` library to your app's dependencies:\n\n1. Access the `manifest.json` file and add `vtex.format-currency` to the `dependencies` list:\n\n`1\n\n dependencies: { \n\n2\n\n+ \"vtex.format-currency\": \"0.x\" \n\n3\n\n } \n\n`\n\n1. Access the file created in the `react` folder for the imported React component.\n2. Once you are in it, import the `FormattedCurrency` component from `vtex.format-currency`.\n3. Use the `<FormattedCurrency value={price} />` format to indicate that the variable `price` should be treated as the price notation value. For example:\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { FormattedCurrency } from 'vtex.format-currency' \n\n3\n\n \n4\n\nconst PriceComponent = () => { \n\n5\n\n const price = 10.50 \n\n6\n\n \n7\n\n return ( \n\n8\n\n <div> \n\n9\n\n <FormattedCurrency value={price} /> \n\n10\n\n </div> \n\n11\n\n ) \n\n12\n\n} \n\n13\n\n \n14\n\nexport default PriceComponent \n\n`\n\n1. Save your code changes.\n\n### Adjusting variable values\n\nIt is common to have a variable in the middle of the message that the component is rendering.\n\nConsider our `HelloWorld` example. To render a greeting following the format `Hello, {userName}!`, we have to use **variable interpolation**.\n\nGiven you have already added the `react-intl` package to your app's dependencies, as explained earlier in this article, follow the instructions below:\n\n1. Access the file created in the `react` folder for the imported React component.\n2. Once you are in it, import the `FormattedMessage` component from `react-intl`, setting the variable `user` (sent as a component parameter) using the following standard format: `<FormattedNumber id={id} values={{ user: user }}/>`. For example:\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { FormattedMessage } from 'react-intl' \n\n3\n\n \n4\n\nconst HelloUser = () => { \n\n5\n\n const user = 'John' \n\n6\n\n \n7\n\n return ( \n\n8\n\n <div> \n\n9\n\n <FormattedMessage id='store/my-app.hello-user' values={{ user: user }} /> \n\n10\n\n </div> \n\n11\n\n ) \n\n12\n\n} \n\n13\n\n \n14\n\nexport default HelloUser \n\n`\n\n1. Access the file containing Messages’ translations for the desired language (`messages/en.json` for example).\n2. For the `FormattedMessage` `id` (in our example, `store/my-app.hello-user`), define the string that will be rendered in English using the value passed in `user`:\n\n`1\n\n{ \n\n2\n\n \"store/my-app.hello-user\": \"Hello {user}!\" \n\n3\n\n} \n\n`\n\n1. Save your code changes.\n\n> If concatenating the string seems complicated, we recommend reading this [documentation](https://read.calvincode.net/reader?url=https://format-message.github.io/icu-message-format-for-translators/index.html). It will help your learning process, explaining more details about formatting messages using ICU and variable interpolation.\n\n### Adjusting gender and number agreement\n\nA variable's gender and number have a direct impact on string concatenation.\n\nFor example, when you do a search, it may return nothing, return one result, or even several results at the same time. That means the answer that we want to render for the user will not remain constant, varying depending on the search itself and the results that are found.\n\nIf we analyze this case, it turns out we could render `No products found`, `One product found`, and `X products found`, respectively.\n\nTo make the messages in your app agree in gender and number in their given scenario, we will use **variable interpolation**.\n\nGiven you have already added the `react-intl` package to your app's dependencies, as explained at the beginning of this article, follow the instructions below:\n\n1. Access the file created in the `react` folder for the imported React component.\n2. Import the `FormattedMessage` component from `react-intl`, setting the `myQuantity` variable (sent as a component parameter). Use the following format: `<FormattedNumber id={id} values={{ quantity: myQuantity }}/>`. For example:\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { FormattedMessage } from 'react-intl' \n\n3\n\n \n4\n\nconst PluralSingularComponent = () => { \n\n5\n\n const myQuantity = 1 \n\n6\n\n \n7\n\n return ( \n\n8\n\n <div> \n\n9\n\n <FormattedMessage id='store/my-app.pluralsingular' values={{ quantity: myQuantity }} /> \n\n10\n\n </div> \n\n11\n\n ) \n\n12\n\n} \n\n13\n\n \n14\n\nexport default PluralSingularComponent \n\n`\n\n1. Access the file containing Messages’ translations for the desired language (`messages/en.json`, for example).\n2. For the `FormattedMessage` `id` (`store/my-app.pluralsingular` in our example), define the string that will be rendered in English as per the value returned by `myQuantity`:\n\n`1\n\n{ \n\n2\n\n \"store/my-app.pluralsingular\": \"{quantity, plural, =0 {No product found} one{One product found} other{# products found}}\" \n\n3\n\n} \n\n`\n\n1. Save your code changes.\n\n> If concatenating the string seems complicated, we recommend reading this [documentation](https://read.calvincode.net/reader?url=https://format-message.github.io/icu-message-format-for-translators/index.html). It will help your learning process, explaining more details about formatting messages using ICU and variable interpolation.\n\n### Adjusting percentage representation\n\nLike prices, percentages are expressed in different ways depending on where you are.\n\nIf the app you are developing has variables with percentages, it is essential to set it up to handle different internationalization scenarios.\n\nGiven you have already added the `react-intl` package to your app's dependencies, as explained at the beginning of this article, follow the instructions below:\n\n1. Access the file created in the `react` folder for the imported React component.\n2. Import the `FormattedNumber` component from `react-intl`, defining the `value` and `style` properties with the following format: `<FormattedNumber value={variable} style=\"percent\"/>`. For example:\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { FormattedNumber } from 'react-intl' \n\n3\n\n \n4\n\nconst PercentageComponent = () => { \n\n5\n\n const percent = 0.1 \n\n6\n\n \n7\n\n return ( \n\n8\n\n <div> \n\n9\n\n <FormattedNumber value={percent} style=\"percent\" /> \n\n10\n\n </div> \n\n11\n\n ) \n\n12\n\n} \n\n13\n\n \n14\n\nexport default PercentageComponent \n\n`\n\n1. Save your code changes.\n\n### Adjusting dynamic messages\n\nThere are cases where you cannot predefine the message displayed by the block because it depends directly on actions taken by users during navigation. A common case of dynamic messages on the interface is HTTP error messages.\n\nGiven you have already added the `react-intl` package to your app's dependencies, as explained at the beginning of this article, follow the instructions below:\n\n1. Access the file created in the `react` folder for the imported React component.\n2. Import the `FormattedMessage` component from`react-intl`, defining the `errorCode` variable (sent as a component parameter) to match the HTTP status code returned. For example:\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { FormattedMessage, defineMessages } from 'react-intl' \n\n3\n\n \n4\n\nconst messages = defineMessages({ \n\n5\n\n 404: { \n\n6\n\n id: 'store/my-app.errors.404', \n\n7\n\n }, \n\n8\n\n 500: { \n\n9\n\n id: 'store/my-app.errors.500', \n\n10\n\n }, \n\n11\n\n}) \n\n12\n\n \n13\n\nconst ErrorMessage = ({ errorCode = 500 }) => { \n\n14\n\n return { \n\n15\n\n <div> \n\n16\n\n <FormattedMessage id={messages[errorCode].id} /> \n\n17\n\n </div> \n\n18\n\n } \n\n19\n\n} \n\n20\n\n \n21\n\nexport default ErrorMessage \n\n`\n\n1. Save your code changes.\n\n> Note that we use a variable to choose the `id` used in the `FormattedMessage` component, making the message dynamic. To declare dynamic messages in your block's code, you need to describe all possible exported messages in an object passed in the `defineMessages` function from the `react-intl` package. This function, which returns the same object without changes, is useful for analyzing the code statically, ensuring that Messages delivers only the messages necessary for the browser to render.\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-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-8-translating-the-component.md)\n\n[6\\. Consuming data« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component//docs/guides/vtex-io-documentation-7-consuming-data)[8\\. Improving performance with cachingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component//docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\nSee also\n\n[8\\. Improving performance with cachingApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Configuring Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23configuring-messages)\n\n[Allowing automatic translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23allowing-automatic-translations)\n\n[Overwriting automatic translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23overwriting-automatic-translations)\n\n[Advanced translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23advanced-translations)\n\n[Adjusting price representations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23adjusting-price-representations)[Adjusting variable values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23adjusting-variable-values)[Adjusting gender and number agreement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23adjusting-gender-and-number-agreement)[Adjusting percentage representation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23adjusting-percentage-representation)[Adjusting dynamic messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23adjusting-dynamic-messages)\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-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-8-translating-the-component.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuring Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23configuring-messages)\n\n[Allowing automatic translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23allowing-automatic-translations)\n\n[Overwriting automatic translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23overwriting-automatic-translations)\n\n[Advanced translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23advanced-translations)\n\n[Adjusting price representations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23adjusting-price-representations)[Adjusting variable values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23adjusting-variable-values)[Adjusting gender and number agreement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23adjusting-gender-and-number-agreement)[Adjusting percentage representation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23adjusting-percentage-representation)[Adjusting dynamic messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component/docs/guides/vtex-io-documentation-8-translating-the-component%23adjusting-dynamic-messages)\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_d9e7f1a4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration stock update in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-guide)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update)\n\nHow to keep stock updated\n\nLearn how to keep integrated products updated with price and inventory level information. Before you start, check out what’s included in the product update flow:\n\n| Included | Not Included |\n| ---------------------------------------------------------------- | --------------------------------------------------------------------- |\n| Prices defined in the VTEX main account | Prices defined in third party sellers or franchise accounts |\n| Prices updated directly to the marketplace integration | |\n| Inventory levels defined in the main account | Inventory levels defined in third party sellers or franchise accounts |\n| Inventory levels updated directly to the marketplace integration | |\n\n## How to configure the affiliate endpoint\n\nTo use this flow, the connector should provide an endpoint according to the standard:\n\n`https://{endpointDoAfiliado}/api/notification/`\n\nThis endpoint should be configured in the VTEX affiliate registration page. Check out our [Configuring an Affiliate](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials%5F187) article.\n\n## VTEX Notification\n\nWhenever the seller updates a product or SKU in VTEX, a notification will be sent through the url configured in the section above. The table below presents the fields sent in this notification’s payload. The connector should use this data to implement the new product registration flow, described in the scenarios that will follow.\n\n### Fields sent in the notification\n\n| Name | Description |\n| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| idSKU | SKU ID in VTEX |\n| productId | Product ID in VTEX |\n| an | Seller’s account name in VTEX, shown in the store’s VTEX Admin url. |\n| idAffiliate | Affiliate ID generated automatically in the configuration. |\n| DateModified | Date when the item was updated |\n| isActive | Identifies whether the product is active or not. In case it is “false”, it means the product was deactivated in VTEX and should be blocked in the marketplace. We recommend that the inventory level is zeroed in the marketplace, and the product is blocked. In case the marketplace doesn’t allow it to be deactivated, the product should be excluded, along with any existing correspondences in the connector. |\n| StockModified | Identifies that the inventory level has been altered. Connectors should send an Fulfillment Simulation request to collect updated information. |\n| PriceModified | Identifies that the price has been altered. Connectors should send an Fulfillment Simulation request to collect updated information. |\n| HasStockKeepingUnitModified | Identifies that the product/SKU registration data has changed, like name, description, weight, etc |\n| HasStockKeepingUnitRemovedFromAffiliate | Identifies that the product is no longer associated with the trade policy. In case the marketplace doesn’t allow it to be deactivated, the product should be excluded, along with any existing correspondences in the connector. |\n\nThe inventory update flow begins when the connector receives a VTEX Catalog notification, indicating that changes have been made to the SKU or product. Besides this notification mechanism, we recommend using an independant inventory update mechanism, so stocks are always updated. The diagram below illustrates the information flow used to keep prices of seller’s SKUs updated in the marketplace integration.\n\n\n\nFollow the steps below to maintain inventory levels updated in the marketplace integration: \n1. Connector validates the VTEX <> Marketplace authentication. In case it has expired, perform the update routine defined in the marketplace’s documentation. Otherwise, connectors should log the error AND put the VTEX notification in a contingency queue.\n2. After receiving the VTEX notification, connectors should: a. Check which store the product belongs to, through the “an” parameter. b. If the `HasStockKeepingUnitModified` is defined as true, the product should be registered or updated in the marketplace. c. Collect details from every SKU using the [Get details of an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku) endpoint. d. Validate if the product is active through the [Get Product by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-product) endpoint, through the `isActive` property. e. Validate if the product is associated with the trade policy used in the marketplace integration through the `salesChannel` property. f. Identify whether the SKU conforms to the marketplace’s product registration rules. g. Validate if the product’s category is mapped in the marketplace. \nIn case it is not mapped, the marketplace should put the SKU in the approvement’s queue, until the [mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper%23post-/api/mkp-category-mapper/categories/marketplace/-id-) is complete. h. Use [Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) (without postalCode) to check if price is configured in the selected trade policy. \n * To collect the product’s price, use the `price` attribute. \n * To collect the sales price configured for that trade policy, use the attribute `salesprice`.\n3. Register operation’s [Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs). Check out [Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs%23content-of-the-messages) for this step.\n\nIf all validations pass, the product or SKU is sent to the marketplace and the operation is logged according to information described in the [Logs made available for users](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs) section.\n\nIf the IDs between VTEX and the marketplace differ, the connector should store both values.\n\n## Recommendations\n\nTo avoid processing gaps due to the big volume of information of the initial load of products, we recommend:\n\n* Using an async messaging architecture, using individual queues by context and store.\n* Creating mechanisms that respect the marketplace API limit rates. We suggest the standard use of the _Circuit Breaker_ integration.\n* In case any of the steps listed above presents failures in communication, we suggest using the contingency mechanism of _deadLetters_.\n* Being TotalReader: whenever possible, in the data transformation process, using standard values accepted by the marketplace, in case the information is not filled or sent by VTEX.\n* In case the marketplace’s processing is in lots - meaning that the connector assembles a group of SKUs, guaranteeing the the limit of records per lot is respected, according to marketplace riles, and sending them to the marketplace at once - it is fundamental to control the lot’s processing, to avoid sending SKU updates without making sure that the product exists in the marketplace.\n* Keeping a states table to know which SKUs have not been integrated with success, attempt date and the response received. This allows the system to use the contingency flow effectively, avoiding infinite loops, and avoiding reaching the request limit.\n\n> Make sure to check out our Recommendations for performing the steps above successfully. Be mindful to make all validations at once, and before the SKU’s publication in the marketplace’s catalog. In case there’s an error detected, the connector presents the seller a list of actions to correct. This way we can avoid the correct - publish - correct cycle.\n\nIf products do not apply to steps a, b and c, an error log must be filed, and the connector should collect the next items on the list obtained by step 2.\n\n## API Reference\n\nUse the endpoints described below to get SKU, price and inventory details. It is important to note that when consuming this API, the connector must have a valid VTEX App Key and App Token. You can also [download our Postman collection](https://read.calvincode.net/reader?url=https://www.getpostman.com/collections/95a809929905a50e2b7b) to access the API. The diagram illustrates the endpoints used in the integration:\n\n\n\n> All parameters in the endpoints below must be declared in the request. In case one of the parameters does not have a value, you must still send it as `null`.[Get list of SKUs associated with a sales channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Fapi-catalog-system-pvt-sku-stockkeepingunitidsbysaleschannel)\n\n[Get details of an SKU associated with a sales channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku)\n\n[Check if product is active](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-products-skus%23productandtradepolicy)\n\n[Simulate price and inventory levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation)\n\n## Scenario 1: Update Inventory level\n\n1. Validate if the `isActive` property is “true”. If otherwise, skip to Scenario 3.\n2. Check if the VTEX `idSKU` and `idSkuMarketplace` are mapped, and if the SKU is already published on the marketplace.\n3. Evaluate if the notification message has the `HasStockKeepingUnitModified` property set as “true”. If otherwise, validate the other JSON properties and execute the following scenarios, if needed.\n4. Use [Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) (without postalCode) to check if price and inventory are configured in the selected trade policy.\n5. Offer a contingency mechanism that allows steps to be repeated in case they fail.\n6. Make the necessary data transformations and [Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs) errors if needed.\n7. Send data to the marketplace.\n8. Register operation’s logs. Check out [Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs%23content-of-the-messages) for this step.\n9. Offer contingency mechanism that verify frequently if inventory levels match in both marketplace and VTEX. We recommend focusing on SKUs with high order rates, regardless of VTEX’s notification.\n\n> Tables should follow the format below. They will be implemented in the integration according to the connector’s documentation.\n\n### Template table for field mapping\n\n| VTEX field | How to fill it in VTEX | VTEX API | Marketplace field | Transformation | Mandatory | BuyBox |\n| ---------- | ---------------------- | --------------------------------- | ----------------- | ------------------------------------------ | --------- | ------ |\n| Name | Catalog page | /api/catalog/pvt/stockkeepingunit | ShortName | Sent to the marketplace only 50 characters | Yes | Yes |\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-stock-update.md)\n\n[How to keep prices updated« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update//docs/guides/external-marketplace-integration-price-update)[Order Integration overviewNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update//docs/guides/external-marketplace-integration-orders)\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[How to configure the affiliate endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23how-to-configure-the-affiliate-endpoint)\n\n[VTEX Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23vtex-notification)\n\n[Fields sent in the notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23fields-sent-in-the-notification)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23recommendations)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23api-reference)\n\n[Scenario 1: Update Inventory level](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23scenario-1-update-inventory-level)\n\n[Template table for field mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23template-table-for-field-mapping)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-stock-update.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[How to configure the affiliate endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23how-to-configure-the-affiliate-endpoint)\n\n[VTEX Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23vtex-notification)\n\n[Fields sent in the notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23fields-sent-in-the-notification)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23recommendations)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23api-reference)\n\n[Scenario 1: Update Inventory level](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23scenario-1-update-inventory-level)\n\n[Template table for field mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update/docs/guides/external-marketplace-integration-stock-update%23template-table-for-field-mapping)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_bb4dd074
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex product summary productsummaryimage in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/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-summary-productsummaryimage/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/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-summary-productsummaryimage/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/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-summary-productsummaryimage/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-summary-productsummaryimage/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-summary-productsummaryimage/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/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-summary-productsummaryimage/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/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-summary-productsummaryimage/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/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-summary-productsummaryimage/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-summary-productsummaryimage/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-summary-productsummaryimage/docs/vtex-io-apps)\n\nProduct Summary Image\n\n[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)\n\nVersion: 2.91.0\n\nLatest version: 2.91.0\n\n`product-summary-image` is a block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary) that renders the product image.\n\n\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme 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-image` block as a child of the `product-summary.shelf` block:\n\n`1\n\n{ \n\n2\n\n \"shelf#home\": { \n\n3\n\n \"blocks\": [\"product-summary.shelf\"] \n\n4\n\n }, \n\n5\n\n \"product-summary.shelf\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"product-summary-name\", \n\n8\n\n \"product-summary-description\", \n\n9\n\n \"product-summary-image\", \n\n10\n\n \"product-summary-price\", \n\n11\n\n \"product-summary-sku-selector\", \n\n12\n\n \"product-summary-buy-button\" \n\n13\n\n ] \n\n14\n\n }, \n\n`\n\n1. Then, declare the `product-summary-image` and configure its behavior using the props stated below.\n\n`1\n\n \"product-summary-image\": { \n\n2\n\n \"props\": { \n\n3\n\n \"showBadge\": true, \n\n4\n\n \"height\": 220 \n\n5\n\n } \n\n6\n\n } \n\n7\n\n} \n\n`\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| showBadge | boolean | Determines whether a discount badge is displayed on the product image. Setting it to true displays the badge if applicable, while false hides it. | true |\n| badgeText | string | Specify the text to be displayed on the discount badge (if the badge is configured to be shown in the product image). | undefined |\n| showCollections | boolean |  Determines whether collection badges, if available, will be displayed (true) or not (false). This prop is deprecated. Use the \\[Product Highlights\\] component instead. | false |\n| displayMode | enum | Defines the Product Summary Image display mode. Possible values are: normal and inline. | normal |\n| placeholder | string | Defines the Product Summary Image placeholder image. | undefined |\n| mainImageLabel | string | Matches the value defined in the imageLabel field from the Admin Catalog. When matched, it determines which product image will be used as the main image displayed in the Product Summary component. | undefined |\n| hoverImageLabel | string |  Text value that matches the value defined in the imageLabel field from the Admin Catalog. When matched, it determines which product image will be displayed when the user hovers over the product. If you set a label and no match is found, no image will be displayed during hover. This prop is deprecated. Use the hoverImage prop instead. | undefined |\n| hoverImage | object | Defines the criteria that should determine the hover image based on the product images in the Admin Catalog. | undefined |\n| width | object | Defines the Product Summary Image width. | undefined |\n| height | object | Defines the Product Summary Image height. | undefined |\n| aspectRatio | object | Defines the aspect ratio of the Product Summary Image, determining whether the image should be displayed in a square, portrait, landscape, or another format. The prop value should follow the [standard aspect ratio notation](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Aspect%5Fratio%5F%28image%29), which consists of two numbers separated by a colon. For example, you can use 1:1 for a square format or 3:4 for an upright portrait. This prop will not work if the width or height props are configured. | undefined |\n| maxHeight | object | Sets the maximum height for the Product Summary Image. This prop will only work if the width or height props are configured. | undefined |\n| fetchpriority | string | Sets the fetch priority hint to ('high', 'low', 'auto', or 'byPosition'). Choose 'byPosition' to adjust the image fetch priority based on its rendering position within search results or lists. This prioritization optimizes performance by ensuring images are fetched based on their relevance in the context. | 'byPosition' |\n\n* `mainImageLabel` object:\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| label | string | Matches the text value with the value defined in the imageLabel field from the Admin Catalog. When matched, it determines which product image will be displayed as the main image in the Product Summary component. If you set a label and no match is found, the main image of the product will be shown instead. | undefined |\n| labelMatchCriteria | enum | Specifies the criteria for searching the image label value. It determines whether the image label should match exactly as provided or if it just needs to contain the substring anywhere in the image label. Possible values are: exact (finds the image that matches exactly the string entered in the label field) and contains (finds the first image that includes the substring entered in the label field). | exact |\n\n* `hoverImage` object:\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| criteria | enum | Defines the criteria that should determine the hover image based on the product images from the Admin Catalog. Possible values are: label (the hover image will be the one that matches the label value) and index (the hover image will be the one with the same index value). | label |\n| label | string | Determines the text string to match the desired image's label value. No image will be displayed during the hover if no match is found. _Caution_: This prop should only be used when the criteria prop is set to label. | undefined |\n| labelMatchCriteria | enum | Defines the criteria for searching the image label value, determining whether the image label should match exactly as provided or just need to contain the substring anywhere in the image label. Possible values are: exact (finds the image that matches exactly the string entered the label field) and contains (finds the first image that includes the substring entered the label field). _This prop should only be used when the criteria prop is set to label_. | exact |\n| index | number | Index number to match with the desired images. No image will be displayed during hover if no match is found. _This prop should only be used when the criteria prop is set to index_. | undefined |\n\n* `width` object:\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------ | ------------- |\n| desktop | number | Image width for desktop users. | undefined |\n| mobile | number | Image width for mobile users. | undefined |\n\n* `height` object:\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------- | ------------- |\n| desktop | number | Image height for desktop users. | undefined |\n| mobile | number | Image height for mobile users. | undefined |\n\n* `aspectRatio` object:\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------------- | ------------- |\n| desktop | string | Image aspect ratio for desktop users. | undefined |\n| mobile | string | Image aspect ratio for mobile users. | undefined |\n\n* `maxHeight` object:\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------- | ------------- |\n| desktop | string | Image maximum height for desktop users. | undefined |\n| mobile | string | Image maximum height for mobile users. | undefined |\n\nThe `width`, `height`, `aspectRatio`, and `maxHeight` props use the [responsive values logic](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/responsive-values%23vtexresponsive-values).\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| hoverImage |\n| hoverEffect |\n| imageContainer |\n| imageInline |\n| imageNormal |\n| imageStackContainer |\n| mainImageHovered |\n\nSee also\n\n[Vtex.product SummaryVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/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/guides/vtex-product-summary-productsummaryimage/docs/apps/vtex.product-summary/ProductSummaryImage%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage/docs/apps/vtex.product-summary/ProductSummaryImage%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_628d969d
|
[
{
"role": "system",
"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 2.18.8 Autocomplete 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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/api-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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/storefront-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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/troubleshooting)\n\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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/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@2.18.8/Autocomplete/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/guides/basic-components)\n\nAutocomplete\n\n[vtex.search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search)\n\nVersion: 2.18.8\n\nLatest version: 2.18.8\n\nAutocomplete is the [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb) feature that displays previous search results based on current and previous searches. These results are presented in four different lists, which can be together or separated, depending on the customer's interaction. It includes:\n\n* Top Searches.\n* Search History.\n* Search Suggestions.\n* Product Suggestions.\n\nDuring the interaction with the search bar, Intelligent Search immediately displays the set of Top Searches and Search History (if the customer has done searches before).\n\nWhen the user starts typing, the system displays the Search suggestions and the Product suggestions and removes the previous lists.\n\nYou can read a detailed explanation of Autocomplete and its features in the [Autocomplete](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL) user guide.\n\n## Before you begin\n\nMake sure you have added the `search` app to your theme dependencies in the `manifest.json` as shown below:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.search\": \"2.x\" \n\n3\n\n } \n\n`\n\nCheck the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) app documentation for more details on this step.\n\n## Usage\n\nAdd `autocomplete-result-list.v2` into the blocks of a `search-bar`. We also recommend to set `openAutocompleteOnFocus` as shown.\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 \"search-bar\": { \n\n6\n\n \"blocks\": [\"autocomplete-result-list.v2\"], \n\n7\n\n \"props\": { \n\n8\n\n \"openAutocompleteOnFocus\": true \n\n9\n\n } \n\n10\n\n } \n\n11\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| maxTopSearches | Number | Maximum number of terms in the top searches list. | 10 |\n| maxHistory | Number | Maximum number of terms in the search history list. | 5 |\n| maxSuggestedProducts | Number | Maximum number of suggested products. | 3 |\n| maxSuggestedTerms | Number | Maximum number of suggested terms. | 3 |\n| autocompleteWidth | Number | Autocomplete width. Number between 0 and 100. | \\- |\n| productLayout | [ProductLayoutEnum](#productlayoutenum) | Defines the product layout in the suggested products list. | \\- |\n| hideTitles | Boolean | If true, all the titles will be hidden. | false |\n| historyFirst | Boolean | If true, the Search History list will be prioritized. | false |\n| customBreakpoints | [CustomBreakpointsProp](#custombreakpointsprop) | Defines a maximum number of suggested products by breakpoints. | \\- |\n| simulationBehavior | \"skip\" or \"default\" | If you want faster searches and do not care about most up to date prices and promotions, use \"skip\" value. | default |\n| customPage | string | Defines a custom page to the autocomplete links. Example: store.search.custom. | store.search |\n| orderBy | enum | Determines which order products must follow when displayed. The possible values are named after the order type: OrderByTopSaleDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, or OrderByNameDESC. ASC and DESC stand for ascending order and descending order, respectively, based on the position of each value's corresponding code in the [ASCII table](https://read.calvincode.net/reader?url=http://www.asciitable.com/). If not set to any of the mentioned values, the fallback behavior is sorting by [relevance settings](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/1qlObWIib6KqgrfX1FCOXS). OrderByScoreDESC is **not** a valid value for this prop. | \"\" |\n\n#### ProductLayoutEnum\n\n| Enum name | Enum value |\n| ---------- | ---------- |\n| Horizontal | HORIZONTAL |\n| Vertical | VERTICAL |\n\n#### CustomBreakpointsProp\n\n| Prop name | Type | Description | Default value |\n| --------- | --------------------------------- | ------------------------------------------- | ------------- |\n| md | [BreakpointProp](#breakpointprop) | Defines the options for the md breakpoint. | \\- |\n| lg | [BreakpointProp](#breakpointprop) | Defines the options for the lg breakpoint. | \\- |\n| xlg | [BreakpointProp](#breakpointprop) | Defines the options for the xlg breakpoint. | \\- |\n\n#### BreakpointProp\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------ | -------------------------------------------------------- | ------------- |\n| width | Number | Minimum width for the breakpoint. | \\- |\n| maxSuggestedProducts | Number | Maximum number of suggested products for the breakpoint. | \\- |\n\n[Add To Cart Button« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.add-to-cart-button)[BannerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search/banner)\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search@2.18.8/Autocomplete%23before-you-begin)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search@2.18.8/Autocomplete%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Autocomplete/docs/apps/vtex.search@2.18.8/Autocomplete%23props)\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_58536742
|
[
{
"role": "system",
"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 SearchBar 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/SearchBar/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/SearchBar/docs/api-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/SearchBar/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/SearchBar/docs/storefront-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/SearchBar/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/SearchBar/docs/troubleshooting)\n\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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/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/SearchBar/docs/vtex-io-apps)\n\nSearch Bar\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 `search-bar` component shows a search bar with autocomplete options and displays the matching products as well. 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 `search-bar` block into the [header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-header) component. For example:\n\n`1\n\n \"header.full\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"login\", \n\n4\n\n \"minicart\", \n\n5\n\n \"logo\", \n\n6\n\n+ \"search-bar\", \n\n7\n\n \"menu-link\", \n\n8\n\n \"telemarketing\", \n\n9\n\n \"category-menu\" \n\n10\n\n ] \n\n11\n\n }, \n\n`\n\n1. Then, declare the `search-bar` block using the props stated in the [Props](#props) table. For example:\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ----------------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| attemptPageTypeSearch | Boolean | If true when clicked on result link of brand, department or category will link to the corresponding brand, department or category page. When false will always go to a full text search page. | false |\n| autocompleteAlignment | [HorizontalAlignment](#horizontalalignment) | Autocomplete Horizontal alignment. Possible values are: left, center, right. | left |\n| autocompleteFullWidth | Boolean | If true, the autocomplete will fill the whole window horizontally. | false |\n| autoFocus | Boolean | Define if the search input should autofocus or not | \\- |\n| blurOnSubmit | Boolean | Define if input should blur on submit. | false |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n| containerMode | enum | Defines how the autocomplete component should be displayed. Possible values are: overlay (suggestions overlapping other components) and container (displays the suggestion within a container). | overlay |\n| compactMode | Boolean | Define when to use the compact version of the component | \\- |\n| customSearchPageUrl | string | Template for a custom url. It can have a substring ${term} used as placeholder to interpolate the searched term. (e.g. /search?query=${term}) | \\- |\n| disableBlurAndTouchEndHandler | Boolean | The autocomplete can have touchable/clickable components. Interacting with those components may trigger blur and touch events that will close the autocomplete. When set to true, this prop will disable those handlers. | false |\n| displayMode | [DisplayMode](#displaymode) | Define the component display mode, such as which buttons should be visible. | clear-button |\n| emptyPlaceholder | String! | Shows a placeholder when the ResultList hasn't results to displayed | \\- |\n| hasIconLeft | Boolean | Define if the search icon is on left or right position | \\- |\n| iconClasses | String |  Custom classes for the search icon. Use the CSS handle searchBarIcon. | \\- |\n| inputType | enum | Defines the value for the type HTML attribute (from the <input> field). Possible values are: search and text. We strongly recommend you to use search as it fixes some iOS issues. The text value is only kept as default for backwards compatibility. | text |\n| maxWidth | Number \\| String | Max width of the search bar | \\- |\n| minSearchTermLength | Number | If defined, it will block searches where the term length is lesser than minSearchTermLength. | \\- |\n| openAutocompleteOnFocus | Boolean | Defines if autocomplete should be open on input focus or not. | false |\n| placeholder | String! | Placeholder to be used on the input | \\- |\n| submitOnIconClick | Boolean |  Defines if search icon should submit on click. Use the displayMode prop instead. | false |\n\n#### `DisplayMode`\n\n| Enum name | Enum value | Empty state | Filled state |\n| ------------------------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| clear-button | 'clear-button' |  |  |\n| search-and-clear-buttons | 'search-and-clear-buttons' |  |  |\n| search-button | 'search-button' |  |  |\n\n## Using SearchBar with Intelligent Search\n\nTo improve the search experience usign the SearchBar component, such as the autocomplete option, you must use the component within [Search app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) responsible for handling the [Intelligent Search (IS)](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search?%5Fga=2.220970832.979717665.1650285782-1001456323.1619912759) solution in IO stores.\n\nThe IS communicates with the `autocomplete-result-list.v2` block exported by the Search app, and the block displays previous search results based on current and previous searches.\n\nFollow the [Search documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) to add the Search app to your store.\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| compactMode |\n| externalSearchButtonWrapper |\n| paddingInput |\n| searchBarContainer |\n| searchBarInnerContainer--opened |\n| searchBarInnerContainer--filled |\n| searchBarIcon |\n| searchBarIcon--clear |\n| searchBarIcon--external-search |\n| searchBarIcon--prefix |\n| searchBarIcon--search |\n| suffixWrapper |\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/SearchBar/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/SearchBar/docs/apps/vtex.store-components@3.178.5/SearchBar%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SearchBar/docs/apps/vtex.store-components@3.178.5/SearchBar%23props)\n\n[Using SearchBar with Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SearchBar/docs/apps/vtex.store-components@3.178.5/SearchBar%23using-searchbar-with-intelligent-search)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SearchBar/docs/apps/vtex.store-components@3.178.5/SearchBar%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_70afdc92
|
[
{
"role": "system",
"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 analytics sending custom 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/faststore/analytics-sending-custom-events/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-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/faststore/analytics-sending-custom-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/faststore/analytics-sending-custom-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/faststore/analytics-sending-custom-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/faststore/analytics-sending-custom-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/faststore/analytics-sending-custom-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/faststore/analytics-sending-custom-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/faststore/analytics-sending-custom-events/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/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/analytics-sending-custom-events/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/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/analytics-sending-custom-events/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-overview)\n\n[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-send-analytics-event)\n\n[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-use-analytics-event)\n\n[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-sending-custom-events)\n\n[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-extending-and-customizing-native-types)\n\n[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/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/analytics-sending-custom-events/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/analytics-sending-custom-events/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/analytics-sending-custom-events/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/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/analytics-sending-custom-events/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-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/faststore/analytics-sending-custom-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/faststore/analytics-sending-custom-events/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/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/analytics-sending-custom-events/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/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/analytics-sending-custom-events/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-overview)\n\n[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-send-analytics-event)\n\n[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-use-analytics-event)\n\n[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-sending-custom-events)\n\n[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-extending-and-customizing-native-types)\n\n[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/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/analytics-sending-custom-events/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/analytics-sending-custom-events/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/analytics-sending-custom-events/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/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/analytics-sending-custom-events/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-overview)\n\nSending custom events\n\nEven though the [Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview) module natively supports [Google Analytics ecommerce events](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/14434488?hl=en), you may need to track customer activity not covered by default events. In such cases, you can trigger and intercept custom events using the [sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event) and [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event) functions. In this guide, you'll learn how to define and send custom events.\n\n> For a practical example of sending custom events, see the [Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events) guide.\n\n## Instructions\n\n### Step 1 - Declaring an interface for your custom event\n\nTo trigger a custom event, you must define an interface that describes the structure of your event object, including its properties and types. You can do this in three ways:\n\n* [Creating a new event interface](#creating-a-new-event-interface)\n* [Extending existing types from the Analytics module](#extending-existing-types-from-the-analytics-module)\n* [Overriding multiple types](#overriding-multiple-types)\n\n#### Creating a new event interface\n\nTo create a custom event interface, use the [sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event) function.\n\nIn the following example, we define a custom event called `WishlistEvent` to track when a user adds a product to their wishlist. Since this is not a standard ecommerce event, we set `isEcommerceEvent: false`:\n\n`1\n\nimport { sendAnalyticsEvent } from '@faststore/sdk' \n\n2\n\n \n3\n\ninterface WishlistEvent { \n\n4\n\n name: 'wishlist_event' \n\n5\n\n isEcommerceEvent: false \n\n6\n\n params: { \n\n7\n\n productId: string \n\n8\n\n productName: string \n\n9\n\n userId: string \n\n10\n\n isLoggedIn: boolean \n\n11\n\n } \n\n12\n\n} \n\n13\n\n \n14\n\nsendAnalyticsEvent<WishlistEvent>({ \n\n15\n\n name: 'wishlist_event', \n\n16\n\n isEcommerceEvent: false, \n\n17\n\n params: { \n\n18\n\n productId: '12345', \n\n19\n\n productName: 'Example Product', \n\n20\n\n userId: 'user-abc', \n\n21\n\n isLoggedIn: true \n\n22\n\n } \n\n23\n\n}) \n\n`\n\nThis custom event interface captures when a user adds a product to their wishlist, logging details like `productId`, `productName`, and whether the user is logged in (`isLoggedIn`). By setting `isEcommerceEvent: false`, the parameters are sent at the top level of the event payload, following the [Google Analytics 4 format for custom events](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/14240153?hl=en).\n\n#### Extending existing types from the Analytics module\n\nIf your event is related to an existing one, you can extend relevant types from the Analytics module. You can do this by using the [TypeScript generics](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/2/generics.html) with the [sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event) function.\n\nThe following example extends the `AddToCartEvent` interface to include the `couponCode` property, which is useful for tracking if a customer applied a coupon code when adding an item to the cart:\n\n`1\n\nimport type { AddToCartEvent } from '@faststore/sdk' \n\n2\n\nimport { sendAnalyticsEvent } from '@faststore/sdk' \n\n3\n\n \n4\n\ninterface AddToCartExtended extends AddToCartEvent { \n\n5\n\n couponCode: string \n\n6\n\n} \n\n7\n\n \n8\n\n/* ... */ \n\n9\n\n \n10\n\nsendAnalyticsEvent<AddToCartExtended>({ name, params, couponCode }) \n\n`\n\n#### Overriding multiple types\n\nIf you have multiple custom events, such as adding/removing items from the cart or viewing products, you can define a unified type to handle them all. This approach simplifies firing multiple events from the same interface.\n\n`1\n\n/* types.ts */ \n\n2\n\nimport { sendAnalyticsEvent } from '@faststore/sdk' \n\n3\n\n \n4\n\ntype AddToCartExtended = /* ... */ \n\n5\n\ntype RemoveFromCartExtended = /* ... */ \n\n6\n\ntype ViewItemExtended = /* ... */ \n\n7\n\ntype SelectItemExtended = /* ... */ \n\n8\n\n \n9\n\ntype ExtendedEvents = \n\n10\n\n| AddToCartExtended \n\n11\n\n| RemoveFromCartExtended \n\n12\n\n| ViewItemExtended \n\n13\n\n| SelectItemExtended \n\n14\n\n \n15\n\ntype SendExtendedAnalyticsEvent = (event: ExtendedEvents) => void \n\n16\n\n \n17\n\nexport const sendExtendedAnalyticsEvent: SendExtendedAnalyticsEvent = (event) => \n\n18\n\nsendAnalyticsEvent<ExtendedEvents>(event) \n\n`\n\n`1\n\n/* MyComponent.tsx */ \n\n2\n\nimport { sendExtendedAnalyticsEvent } from './types' \n\n3\n\n \n4\n\n/* ... */ \n\n5\n\n \n6\n\nsendExtendedAnalyticsEvent({ /* Extended event object */}) \n\n`\n\nThe example above sets up a flexible way to fire multiple custom events. Instead of managing multiple event types separately, the purpose of the example is to handle them all through a single interface. You can use this setup to track diverse customer interactions, such as adding/removing products from the cart, viewing products, or saving items to the wishlist.\n\n### Step 2 - Intercepting custom events\n\nAfter defining the event interface, you'll need to intercept these events using the `useAnalyticsEvent` hook. Below is an example of how to set up an event handler:\n\n`1\n\nimport { useAnalyticsEvent } from '@faststore/sdk' \n\n2\n\n \n3\n\nimport type { ArbitraryEvent } from './types' \n\n4\n\n \n5\n\nexport const AnalyticsHandler = () => { \n\n6\n\nuseAnalyticsEvent((event: ArbitraryEvent) => { \n\n7\n\n}) \n\n8\n\n \n9\n\n/* ... */ \n\n10\n\n \n11\n\nreturn null \n\n12\n\n} \n\n`\n\nNote that to target extended properties of events, you'll also need to configure the types of your [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event) callback function to expect an event of that type.\n\n`1\n\nimport { useAnalyticsEvent } from '@faststore/sdk' \n\n2\n\n \n3\n\nimport type { ExtendedEvents } from './types' \n\n4\n\n \n5\n\nexport const AnalyticsHandler = () => { \n\n6\n\n \n7\n\nuseAnalyticsEvent((event: ExtendedEvents) => { \n\n8\n\n /* ... */ \n\n9\n\n}) \n\n10\n\n \n11\n\n/* ... */ \n\n12\n\n \n13\n\nreturn null \n\n14\n\n} \n\n`\n\n> By typing the callback function with the extended types, you can reference properties not natively provided by the Analytics module.\n\n### Step 3 - Firing custom events\n\nNow that you've declared your event interface and intercepted it with the `useAnalyticsEvent` hook, you can implement it in your components to fire the event.\n\n`1\n\nimport { useCallback } from 'react' \n\n2\n\nimport { sendAnalyticsEvent } from '@faststore/sdk' \n\n3\n\n \n4\n\nconst MyComponent = () => { \n\n5\n\nconst handleCustomEvent = useCallback(() => { \n\n6\n\n sendAnalyticsEvent({ \n\n7\n\n name: 'custom_action', \n\n8\n\n isEcommerceEvent: false, \n\n9\n\n params: { \n\n10\n\n action_type: 'button_click', \n\n11\n\n component_name: 'MyComponent', \n\n12\n\n timestamp: new Date().toISOString() \n\n13\n\n } \n\n14\n\n }) \n\n15\n\n}, []) \n\n16\n\n \n17\n\nreturn <button onClick={handleCustomEvent}>Trigger Custom Event</button> \n\n18\n\n} \n\n`\n\n> Use `isEcommerceEvent: false` for custom events that track user interactions, feature usage, or other non-commerce activities. Reserve the default `isEcommerceEvent: true` (or omit it) for events related to the shopping funnel (add to cart, purchase, etc.).\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/faststore/docs/sdk/analytics/sending-custom-events.mdx)\n\n[useAnalyticsEvent« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-use-analytics-event)[Extending and customizing native typesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-extending-and-customizing-native-types)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-sending-custom-events%23instructions)\n\n[Step 1 - Declaring an interface for your custom event](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-sending-custom-events%23step-1-declaring-an-interface-for-your-custom-event)[Step 2 - Intercepting custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-sending-custom-events%23step-2-intercepting-custom-events)[Step 3 - Firing custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-sending-custom-events%23step-3-firing-custom-events)\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/analytics/sending-custom-events.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/analytics-sending-custom-events/docs/guides/faststore/analytics-sending-custom-events%23instructions)\n\n[Step 1 - Declaring an interface for your custom event](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-sending-custom-events%23step-1-declaring-an-interface-for-your-custom-event)[Step 2 - Intercepting custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-sending-custom-events%23step-2-intercepting-custom-events)[Step 3 - Firing custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events/docs/guides/faststore/analytics-sending-custom-events%23step-3-firing-custom-events)\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_6f8de7dc
|
[
{
"role": "system",
"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 cross border stores in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Checking your store's binding ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/checking-your-stores-binding-id)\n\n[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)\n\n[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/cross-border-custom-urls-1)\n\n[Managing landing pages in cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)\n\n[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Checking your store's binding ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/checking-your-stores-binding-id)\n\n[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)\n\n[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/cross-border-custom-urls-1)\n\n[Managing landing pages in cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)\n\n[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)\n\nSetting up cross-border stores\n\nCross-border stores are a specialized type of [multistore](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-multi-store-multi-domain--tutorials%5F510?locale=en), where a single VTEX account manages multiple stores across different countries or regions.\n\nThis setup is ideal for stores with different brands and business models that require multiple operational environments. In a multistore setup — also known as a subaccount or multidomain — each store can be configured independently, which means that layouts, products, prices, and logistics can be tailored to each region and domain.\n\nIn a cross-border context, a multistore setup allows a single VTEX account to manage multiple stores, such as:\n\n* `http://{storeName}.com/en` (English store)\n* `http://{storeName}.com/pt` (Portuguese store)\n\n> To become a cross-border store, open a [VTEX support ticket](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk) and request the setup of a multistore environment.\n\n## Before you begin\n\n### Define your operation\n\nBefore implementing your cross-border store, make sure you have the following information ready:\n\n* **Target regions:** Identify the countries/regions where your store will operate.\n* **Currencies and Languages:** Determine accepted payment currencies and supported site languages.\n* **Inventory management:** Decide if inventory will be managed from Brazil or locally in each country/region.\n* **Tax and Export partner:** If using fulfillment from Brazil, choose a partner for handling export taxes and fees. To find your partner, check out the [Partners](https://read.calvincode.net/reader?url=https://vtex.com/en-us/partners/) page on the VTEX website.\n* **Catalog translation:** Check if your catalog is translated or needs localization for each country/region.\n* **Promotions:** Plan the types of promotions for each store. Learn about the types available in [Promotions](https://read.calvincode.net/reader?url=https://help.vtex.com/subcategory/benefits--1yTYB5p4b6iwMsUg8uieyq) guides.\n* **Operations:** Consider any existing physical stores, sellers, or other operations abroad. Learn more in [VTEX account types](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/4yPqZQyj0t675QpcG7H6yl%23vtex-account-types)\n* **Teams:** Identify if different teams will manage each country/region’s ecommerce operations.\n* **ERP Systems:** Confirm if each country/region has its own ERP or a centralized system.\n* **Payment gateway:** Ensure you have a gateway that supports multiple currencies.\n* **Domains:** Define the primary and secondary domains for your stores. Learn more in [Rules for main hosts](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/configuring-the-store-domain--tutorials%5F2450%23rules-for-main-host).\n\nThis information will help you to choose the most suitable architecture for your cross-border store.\n\n### Choose your store architecture\n\nAfter defining your operation based on the topics above, choose the architecture for your cross-border store following the section [Multi-language and multi-currency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-architecture%23multi-language-and-multi-currency) within the Store Architecture guide.\n\n## Essential concepts\n\nTo better understand how a VTEX cross-border multistore works, it's essential to understand the key concepts of bindings and trade policies.\n\n### Binding\n\nIn VTEX, **binding** is the process of linking a website, store name, and trade policy to create a unique identifier for each store. This is essential for managing multiple stores within a single VTEX account.\n\nEach store has a unique binding value, which is crucial for routing and configuring store-specific settings.\n\n> To check the `binding` value of your stores, follow the [Checking your store's binding id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-your-stores-binding-id) guide.\n\n### Trade Policies\n\nA **trade policy** is a set of configurations that define a store's catalog, pricing, and logistics strategy. Each store can have its own trade policy, allowing for different setups depending on the market. For example, if the pricing structure differs between your stores in Spain and France, you'll need separate trade policies.\n\nHowever, if two stores share the same logistics, catalog, and prices, they can use a common trade policy.\n\n> To learn more, see the guide [How trade policies work](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV).\n\n## Guides in this section\n\n[Checking your store's binding idUnderstand how to identify the unique binding ID for each store in your cross-border setup.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-your-stores-binding-id)[Creating robots files for cross-border storesLearn how to configure \\`robots.txt\\` files to manage search engine indexing for cross-border stores.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)[Cross-border store content internationalizationDiscover how to customize URLs and manage content localization for cross-border stores.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1)[Managing landing pages in cross-border storesLearn how to manage landing pages tailored for different regions.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)[Indicating alternate versions of localized pages in cross border storesDiscover how to set up alternate page versions in cross-border stores.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)\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-setting-up-cross-border-stores.md)\n\n[Setting up Google Tag Manager events and triggers« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores//docs/guides/vtex-io-documentation-setting-up-google-tag-manager)[Checking your store's binding IDNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores//docs/guides/checking-your-stores-binding-id)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23before-you-begin)\n\n[Define your operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23define-your-operation)[Choose your store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23choose-your-store-architecture)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23essential-concepts)\n\n[Binding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23binding)[Trade Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23trade-policies)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%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-setting-up-cross-border-stores.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23before-you-begin)\n\n[Define your operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23define-your-operation)[Choose your store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23choose-your-store-architecture)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23essential-concepts)\n\n[Binding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23binding)[Trade Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23trade-policies)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%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_f98700ee
|
[
{
"role": "system",
"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 events to trigger side effects on store components in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/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/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/store-framework-dealing-with-events)\n\n[Using events to trigger side effects on store components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components)\n\nUsing events to trigger side effects on store components\n\nEvents or pixel events are notifications broadcast by your storefront whenever a user performs a tracked action, such as:\n\n* Adding an item to the cart (`addToCart` event).\n* Removing an item from the cart (`removeItem` event).\n* Accessing a loaded page (`pageView` event).\n* Viewing a product (`productImpression` event).\n\nAnalytics tools commonly use these events to track users' shopping behavior and interactions across your store pages.\n\nYou can also use events to create dynamic interactions between your store components by using the `customPixelEventId` prop. These events can generate side effects in the UI, triggering automatic behaviors in your store components as needed.\n\nThe `customPixelEventId` prop can be used as either an event sender or receiver, depending on its implementation. When used in a sender component, it emits an event in response to user interaction. In a receiver component, it listens for that specific event and triggers a corresponding UI update.\n\nThe prop's value must be a unique ID, enabling blocks to identify which event is being sent or received during user interaction in the UI.\n\nThe following table lists the components that support the `customPixelEventId` prop:\n\n| Block name | Behavior |\n| ------------------ | ------------------------------------------- |\n| add-to-cart-button | Sends an event when clicked. |\n| minicart.v2 | Receives an event and performs a UI action. |\n| drawer-trigger | Sends an event when clicked. |\n| drawer | Receives an event and performs a UI action. |\n| modal-trigger | Sends an event when clicked. |\n| modal-layout | Receives an event and performs a UI action. |\n\n## Use case example\n\nIn this section, we describe how events and the `customPixelEventId` prop can trigger side effects in the interface. Follow the steps below to configure the [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart) to automatically open when a new product is added using the [Add to Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button).\n\n\n\n### Instructions\n\n#### Step 1 - Add dependencies\n\nIn your theme's `manifest.json` file, make sure the `minicart` and `add-to-cart-button` apps are listed as dependencies:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.minicart\": \"2.x\", \n\n3\n\n \"vtex.add-to-cart-button\": \"0.x\" \n\n4\n\n} \n\n`\n\n#### Step 2 - Configure the event sender\n\nIn your store theme code, declare the `customPixelEventId` prop in the block responsible for sending the desired event, passing a unique ID as its value. Example:\n\n`1\n\n{ \n\n2\n\n \"add-to-cart-button#example\": { \n\n3\n\n \"props\": { \n\n4\n\n \"customPixelEventId\": \"example-add-to-cart\" \n\n5\n\n } \n\n6\n\n }, \n\n7\n\n} \n\n`\n\n#### Step 3 - Configure the event receiver\n\nIn the `minicart.v2` block, declare the `customPixelEventName` prop in the block responsible for listening for the desired event. Use the same unique ID that you declared in the sender block. Example:\n\n`1\n\n{ \n\n2\n\n \"minicart.v2\": { \n\n3\n\n \"props\": { \n\n4\n\n \"customPixelEventName\": \"example-add-to-cart\" \n\n5\n\n }, \n\n6\n\n \"children\": [\"minicart-base-content\"] \n\n7\n\n } \n\n8\n\n} \n\n`\n\n> The `customPixelEventName` prop triggers the `minicart.v2` to open automatically in the interface whenever it detects a pixel event with the specified name. If you also set a `customPixelEventId` prop on the sender, the `minicart.v2` opens only if both the event's name and custom ID match. Learn more in [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart).\n\nAfter saving your changes and [deploying your new Store Theme version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available), the Add to Cart Button component will send the `example-add-to-cart` event when clicked. The Minicart will then automatically open in response to any event with this ID.\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/concepts-1/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components.md)\n\n[Improving filter navigator experience« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components//docs/guides/vtex-io-documentation-improving-filter-navigator-experience)[Configuring Analytics (Google Tag Manager)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components//docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Use case example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components%23use-case-example)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-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/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Use case example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components%23use-case-example)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-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_fb240085
|
[
{
"role": "system",
"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 pixel 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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-app/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-pixel-app)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\n\n[2\\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\n[3\\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-4-configuringyourappsettings)\n\n[4\\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)\n\n[5\\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-6-listeningtostoreevents)\n\n[6\\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-7-structuringthedocumentation)\n\n[7\\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/create-master-data-crud-app)\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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-app/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-pixel-app)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\n\n[2\\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\n[3\\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-4-configuringyourappsettings)\n\n[4\\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)\n\n[5\\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-6-listeningtostoreevents)\n\n[6\\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-7-structuringthedocumentation)\n\n[7\\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/create-master-data-crud-app)\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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-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-pixel-app/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-getting-started)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app/docs/guides/vtex-io-documentation-pixel-app)\n\nPixel app\n\nA Pixel app is a specialized application that connects your VTEX store to third-party services by automatically injecting necessary scripts and configurations into your store's pages. This integration allows for data collection and interaction with external services like analytics and user support platforms, without the need for manual script management.\n\nAfter installation, the Pixel app automatically injects the necessary tracking scripts and, when applicable, custom JavaScript configurations into your store’s pages, ensuring that the integrated third-party solutions work as expected.\n\nExamples of native Pixel apps include: [Facebook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-pixel/), [Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/) and [Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/).\n\n> For a full list of native Pixel apps, refer to the [Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pixel-apps/) documentation.\n\nIf the desired integration is not available, you can either contact the product team on [VTEX Community](https://read.calvincode.net/reader?url=https://community.vtex.com/) or [developer your own pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps) tailored to your store's requirements.\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-pixel-app.md)\n\n[Pixel apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app//docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)[1\\. Setting up your development environmentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app//docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\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-pixel-app.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_7ca3957b
|
[
{
"role": "system",
"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 checkout settings 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-checkout-settings/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-checkout-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/guides/vtex-b2b-checkout-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/guides/vtex-b2b-checkout-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/guides/vtex-b2b-checkout-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/guides/vtex-b2b-checkout-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/guides/vtex-b2b-checkout-settings/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/updates/release-notes)\n\nB2B Checkout Settings\n\n> The **B2B Checkout Settings** app is part of VTEX’s [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite) solution, a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships. We recommend that you use it alongside the other apps in this suite for all functionalities to work as expected.\n\nIn B2B commerce, it is often necessary to provide customized options during checkout, such as:\n\n* Making specific payment methods available for each organization or cost center.\n* Providing pre-filled addresses.\n* Including a purchase order number in the order.\n* Offering the option to create an order quote before making an actual purchase.\n\nThe **B2B Checkout Settings** app works alongside other **B2B Suite** apps to extend the checkout experience for users who are members of organizations, adding all the above possibilities to the checkout page.\n\n## Before you begin\n\nFirst, make sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed in your machine.\n\nTo use **B2B Checkout Settings**, you must have the [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations) app installed in your store, which will enable you to group B2B users into organizations, with their own assigned payment methods, price tables, product collections, and cost centers.\n\nYou must also have the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions) app installed – it allows you to grant specific storefront roles for B2B users in an organization. See the **Storefront Permissions** app documentation for information on the available roles and how to customize their permissions.\n\n## Installation\n\nYou can install this app by running `vtex install vtex.b2b-checkout-settings` in your terminal, using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\nAfter this command, the app will be installed in your VTEX Admin, and B2B store administrators can access it on **Store Setup** \\> **B2B Checkout Settings**.\n\n## How it works\n\nConsidering B2B stores often need similar customizations, **B2B Checkout Settings** provides a ready-to-use customized checkout page for B2B scenarios.\n\nOnce **B2B Checkout Settings** is installed in your account, every script contained in its [checkout-ui-custom folder](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/b2b-checkout-settings/tree/master/checkout-ui-custom) will be automatically linked to your store. The app will customize your checkout page with the functionalities described below. You will also be able to [configure](#configuration) the app on **Store Setup** \\> **B2B Checkout Settings**.\n\n> The behavior of the checkout page in VTEX stores is customizable through JavaScript code. In case you need additional customization, we recommend that you use [Checkout UI Custom](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-checkout-ui-custom/p) if you prefer using the VTEX Admin interface or [Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings) if you prefer a code-only option.\n\n### Restricted access to checkout\n\nThis app automatically checks users’ roles within the organization by communicating with the **B2B Organizations** app, and validates if the user has the required permissions to access checkout, by communicating with the Storefront Permissions app.\n\nBy default, users with any storefront role can access checkout, except for users with the **Organization Buyer** role. Any attempt to proceed to checkout without the required permission will result in a notification with the following message: _You don’t have access to the checkout_.\n\nNote that if you have [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui) installed, you can customize these permissions on the VTEX Admin by accessing **Account Settings > Storefront Permissions**.\n\n### Cost Center addresses\n\nThe **B2B Checkout Settings** app communicates with the **B2B Organizations** app and automatically lists the [Cost Center addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23cost-center-details) associated with the user during checkout:\n\n|  |\n| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Cost Center Details** page, displaying two options of addresses associated with the cost center in question |\n\n|  |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Cost Center Details** page, displaying two options of addresses associated with the cost center in question |\n\n### Purchase order number field\n\nA purchase order (PO) is a commercial agreement between a buyer company and a B2B store, authorizing the payment for products or services to be delivered in the future within a specific time frame.\n\nHaving a purchase order number allows B2B customers to pay for authorized purchases by referencing this number. The purchase order is authorized and issued in advance by the company that is making the purchase.\n\nUsing **B2B Checkout Settings**, it is possible to enable an optional **Reference or PO Number** field for customers to insert this information during the checkout.\n\n\n\nSee the [Configuration](#configuration) section to understand how to enable or disable this button.\n\n## Configuration\n\nTo change app settings, in the VTEX Admin go to **Store Setup** \\> **B2B Checkout Settings**.\n\n\n\nYou can use the toggle button to activate or deactivate the available settings:\n\n* **Show Purchase Order Number Field:** enabling this will add the **Reference or PO Number** input field to the checkout page. This will allow users to insert a purchase order number during checkout.\n* **Show 'Create a Quote' Button:** enabling this will add the `Create a Quote` button to checkout, which allows users to create a quote using the current contents of their cart.\n\n> You should only enable the `Create a Quote` button if your store has the [B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes) app installed. Check the **B2B Quotes** app documentation for more information on how order quotes work.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-b2b-suite/vtex-b2b-checkout-settings.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23installation)\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23how-it-works)\n\n[Restricted access to checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23restricted-access-to-checkout)[Cost Center addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23cost-center-addresses)[Purchase order number field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23purchase-order-number-field)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23configuration)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-b2b-suite/vtex-b2b-checkout-settings.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-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23installation)\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23how-it-works)\n\n[Restricted access to checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23restricted-access-to-checkout)[Cost Center addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23cost-center-addresses)[Purchase order number field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23purchase-order-number-field)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings/docs/guides/vtex-b2b-checkout-settings%23configuration)\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_4badd607
|
[
{
"role": "system",
"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 stack 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-stack-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-stack-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-stack-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-stack-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-stack-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-stack-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-stack-layout/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-stack-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-stack-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-stack-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-stack-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-stack-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-stack-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-stack-layout/updates/release-notes)\n\nStack Layout\n\nUse this layout component to show blocks on top of other blocks.\n\n\n\nEach children passed to `stack-layout` will receive an increasingly higher value of `zIndex`.\n\nThis means `flex-layout.row#viewone` will appear on the bottom, `flex-layout.row#viewtwo` will appear over it with `zIndex` of value 2, and `flex-layout.row#viewthree` will appear over them both with `zIndex` of value 3\\. Another thing to notice is that you pass the `blockClass` prop to any children of the `stack-layout` it will apply the `blockClass` to the element that wraps child element.\n\n## Configuration\n\n1. Import the breadcrumb's app to your theme's dependencies in the `manifest.json`, for example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.stack-layout\": \"0.x\" \n\n3\n\n } \n\n`\n\n1. Add the `stack-layout` block to your template. For example:\n\n`1\n\n\"stack-layout\": { \n\n2\n\n \"children\": [\"flex-layout.row#viewone\", \"flex-layout.row#viewtwo\", \"flex-layout.row#viewthree] \n\n3\n\n} \n\n`\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| zIndexOffset | number | An offset to be passed to the zIndex of the children of the stack layout. If you pass 3, the first children will have zIndex of 3 and the next layer will have zIndex of 4, and so on. | 0 |\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| stackContainer |\n| stackItem |\n| stackItem--first |\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/layout-apps/vtex-stack-layout.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-stack-layout/docs/guides/vtex-stack-layout%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-stack-layout/docs/guides/vtex-stack-layout%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/layout-apps/vtex-stack-layout.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-stack-layout/docs/guides/vtex-stack-layout%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-stack-layout/docs/guides/vtex-stack-layout%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_8fcddff5
|
[
{
"role": "system",
"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 quotes 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-quotes/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-quotes/docs/api-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-quotes/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-quotes/docs/storefront-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-quotes/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-quotes/docs/troubleshooting)\n\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-quotes/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/updates/release-notes)\n\nB2B Quotes & Carts\n\n> The **B2B Quotes & Carts** app is part of VTEX’s [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite) solution: a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships. We recommend that you use it alongside the other apps in this suite for all functionalities to work as expected.\n\nThe B2B shopping experience frequently requires the possibility for customers to request quotes and negotiate prices with sales representatives.\n\nThe **B2B Quotes & Carts** app allows customers who are part of [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations) to request a quote for a shopping cart and save it for future use – including its items, product quantities and prices. This enables price negotiations between them and the store’s sales representatives, as well as order approval flows within their organization.\n\n## Before you begin\n\nFirst, make sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed in your machine.\n\nNote that installing **B2B Quotes & Carts** will also result in [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions) being installed as a dependency app – it allows you to grant specific storefront roles for B2B users in an organization. This is especially useful for organizations with multiple users who have different responsibilities, such as placing orders, approving orders or managing the organization users. See the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions) app documentation for information on the available roles and how to customize their permissions (optional).\n\nIf you want to be able to manage roles and permissions on the VTEX Admin, you must install [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui) as well.\n\nAlong with this app, we recommend installing [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings), which includes quotes-related functionalities to checkout. For example, it allows you to add a `Create a Quote` button to the checkout’s shopping cart page, as well as “lock” the checkout if a quote is in use, preventing the cart contents from being changed until the order is placed.\n\n## Installation\n\nYou can install the **B2B Quotes & Carts** app by running `vtex install vtex.b2b-quotes` in your terminal, using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\n## How the app works\n\nThe **B2B Quotes & Carts** app enables a shared [My Quotes](#my-quotes) page for members of a B2B organization, from where it is possible to create a quote or saved cart and view existing quotes and saved carts.\n\nIt is also possible to manage each quote or saved cart’s [details](#quote-details), including the possibility to edit them, request adjustments, approve or decline them or use them to place an order.\n\nIn addition, the app enables a set of [email templates](#email-templates) to notify members of the organization of quote status changes through Message Center.\n\nThe ability to use these resources depends on having the required [storefront permissions](#storefront-permissions), as explained in the next section.\n\n| **Permission** | **Default roles** |\n| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| **Create Quotes and Carts** | Store AdminSales AdminSales ManagerSales RepresentativeOrganization AdminOrganization ApproverOrganization Buyer |\n| **Access My Cost Center's Quotes and Carts** | Sales RepresentativeOrganization ApproverOrganization Buyer |\n| **Access My Organization's Quotes and Carts** | Sales ManagerOrganization Admin |\n| **Access All Quotes and Carts** | Store AdminSales Admin |\n| **Place Orders from Quotes and Carts** | Store AdminSales AdminSales ManagerSales RepresentativeOrganization AdminOrganization Approver |\n| **Decline Quotes and Carts** | Store AdminSales AdminSales ManagerSales RepresentativeOrganization AdminOrganization Approver |\n| **Edit My Cost Center's Quotes and Carts** | Sales Representative |\n| **Edit My Organization's Quotes and Carts** | Sales Manager |\n| **Edit All Quotes and Carts** | Store AdminSales Admin |\n\nIf you want to be able to manage roles and permissions for **B2B Quotes & Carts** on the VTEX Admin, you must install [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui) and refer to its documentation.\n\n### My Quotes\n\nThe **B2B Quotes & Carts** app enables the **My Quotes** page, an interface to manage quotes and saved carts in the storefront, provided that the user is logged in and has the required storefront permissions.\n\nTo access **My Quotes**, customers or sales users must follow the instructions below.\n\n1. Access the storefront and log in.\n2. Click `Hello, {name}`.\n3. Click on **My Account**.\n4. Go to **Quotes and Saved Carts** on the sidebar. You will see the page below.\n\n\n\n> Quotes and saved carts are shown together in the same table. The differences are the following:\n> \n> * Only quotes can have a status of **Pending** or **Revised**.\n> * Sales users are not notified when saved carts are created. It is possible to edit a saved cart such that it becomes a quote, as explained in [Quote Details](#quote-details).\n\nIn this page, it is possible to use the following resources:\n\n* **Search bar**: allows you to look up specific quotes or saved carts by name.\n* **Filters**: allows you to filter the displayed quotes or saved carts by _Status_, _Organization_ or _Cost Center._ The two last options are available under `More`.\n* **New quote**: allows you to create a quote or saved cart by clicking on the `New Quote` button. See more details on this in the [Creating a quote or saved cart](#creating-a-quote-or-saved-cart) section.\n\nThe list of quotes and saved carts displays the following information:\n\n* **Ref. Name:** the quote or saved cart’s reference name.\n* **Subtotal:** subtotal of the shopping cart associated with the quote or saved cart.\n* **Created by:** email of the user who created the quote or saved cart.\n* **Created on:** date when the quote or saved cart was created, in the MM/DD/YYYY format.\n* **Expiration:** date when the quote or saved cart will expire, in the MM/DD/YYYY format.\n* **Status:** current state of the quote or saved cart, including the following options: \n * **Ready**: the quote or saved cart is ready to be used to place an order. \n * **Pending**: the quote is waiting for review and adjustment by a sales user. \n * **Revised**: the quote is waiting for additional review and adjustment by a sales user. \n * **Declined**: the quote or saved cart has been declined and cannot be used to place an order. \n * **Expired**: the quote or saved cart has reached its expiration date and cannot be used to place an order. \n * **Placed**: the quote or saved cart has been used to place an order and cannot be used again.\n* **Last Update:** date when the quote or saved cart was updated for the last time, in the MM/DD/YYYY format.\n* **Organization:** name of the organization the quote or saved cart is associated with.\n* **Cost Center:** name of the cost center the quote or saved cart is associated with.\n\nFrom the list, users may click on any row or click on  **\\> Details** to view and edit the [details](#quote-details) of that quote or saved cart, according to what their permissions allow.\n\nDepending on the current user’s [storefront permissions](#storefront-permissions), the **My Quotes** page will show a list of quotes and saved carts containing one of the following:\n\n| **Permission** | **Content** |\n| --------------------------------------------- | ------------------------------------------------------------------------------- |\n| **Access My Cost Center's Quotes and Carts** | All quotes and saved carts created by users in the current user’s cost center. |\n| **Access My Organization's Quotes and Carts** | All quotes and saved carts created by users in the current user’s organization. |\n| **Access All Quotes and Carts** | All quotes and saved carts in the current store, regardless of organization. |\n\n### Creating a quote or saved cart\n\nIn order to create a quote or saved cart, it is necessary to have the **Create Quotes and Carts** [permission](#storefront-permissions). After adding products to the cart in the storefront, users with these permissions can use the contents of their cart to create a saved cart or to request a quote. They should follow the instructions below.\n\n1. Fill in the shopping cart with the desired products.\n2. Take one of the following actions to create a quote or saved cart: \n * Clicking the `Create a Quote` button during checkout, provided that **B2B Checkout Settings** is installed and this button is enabled in the app’s [configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings%23configuration). \n * Navigating to the `/b2b-quotes/create` route. \n * Clicking the `+ New` button on the **My Quotes** page. \n Any of these paths will lead to the **Create Quote** page, illustrated below.\n3. Fill in the quote or saved cart’s **Name**.\n4. Make sure that all the information in the **Create Quote** page is correct: \n * **Original Subtotal:** subtotal of the shopping cart before any discounts. \n * **Percentage Discount:** percentage of the discount offered by a sales representative. \n * **Quoted Subtotal:** subtotal of the quote, including any discounts offered by sales representatives. \n * **Image:** image of the selected product. \n * **Ref. Code:** reference code of the selected product. \n * **Name:** name of the product. \n * **Original Price:** original price of the product. \n * **Quoted Price:** price of the product including any discounts offered by sales representatives. \n * **Quantity:** quantity of items. \n * **Total:** total value considering the quoted price and the quantity of items.\n5. Write a note in the optional **Add Note** field, if necessary. \nNotes added here will be visible as part of the quote or saved cart’s [Update History](#quote-details) and can be seen by salespeople or other members of your organization and cost center. For example, if a user wishes to request a specific discount from the B2B store’s salesperson, they may include this request as a note.\n6. Click on one of the following options: \n * `Save for later`: clicking on this button will result in the creation of a saved cart. The status of the newly created saved cart will be set as **Ready**, meaning that it can immediately be used to place an order by any user within that organization or cost center who has the **Place Orders from Quotes and Carts** [permission](#storefront-permissions). \n * `Request quote`: clicking on this button will result in the creation of a quote. The status of the newly created quote will be set as **Pending**, meaning that it will need to be reviewed and adjusted by a salesperson before any special discounts can be applied. \n Note that a **Pending** quote can still be used to place an order, as it is essentially a saved cart at this point, with the original item quantities and prices from the user’s shopping cart.\n\nThe items in the table, along with the quantities and prices shown, will be saved when the quote or saved cart is created.\n\n\n\n### Quote Details\n\nThe **Quote Details** page displays all the information about a specific quote or saved cart, as well as the available actions, depending on its status and the user’s [storefront permissions](#storefront-permissions).\n\nUsers can access this page through the storefront by going to **My Account > Quotes and Saved Carts**.\n\n\n\nThis page displays the following information about a specific quote:\n\n* **Name:** reference name of the quote or saved cart.\n* **Original Subtotal:** subtotal of the shopping cart before any discounts.\n* **Percentage Discount:** percentage of the discount offered by a sales representative.\n* **Quoted Subtotal:** subtotal of the quote, including any discounts offered by sales representatives.\n* **Expiration:** date when the quote or saved cart will expire, in the MM/DD/YYYY format.\n* **Status:** current state of the quote or saved cart, as in [My Quotes](#my-quotes).\n* **Image:** image of the selected product.\n* **Ref. Code:** reference code of the selected product.\n* **Name:** name of the product.\n* **Original Price:** original price of the product.\n* **Quoted Price:** price of the product including any discounts offered by sales representatives.\n* **Quantity:** quantity of items.\n* **Total:** total value considering the quoted price and the quantity of items.\n* **Update History:** includes a history of all events related to the quote, such as its creation and discounts offered, including notes if there are any.\n* **Add Note:** optional field to write comments or notes. Notes added here will be visible as part of the quote or saved cart’s [Update History](#update-history). For example, if a user wishes to request a specific discount from their salesperson, they may include this request as a note.\n\nThe following actions are available, depending on the user’s storefront permissions:\n\n| Actions | Required storefront permissions |\n| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| [Editing a quote](#editing-a-quote) | Any of the following:Edit My Cost Center's Quotes and CartsEdit My Organization's Quotes and CartsEdit All Quotes and Carts |\n| [Requesting additional adjustments to a quote](#requesting-additional-adjustments-to-a-quote) | Any of the following:Access My Cost Center's Quotes and CartsAccess My Organization's Quotes and CartsAccess All Quotes and Carts |\n| [Declining a quote or saved cart](#declining-a-quote-or-saved-cart) | Decline Quotes and Carts |\n| [Using a quote or saved cart to place an order](#using-a-quote-or-saved-cart-to-place-an-order) | Place Orders from Quotes and Carts |\n\n#### Editing a quote\n\nUsers with **Edit** [permissions](#storefront-permissions) – who are typically users associated with any of the Sales roles or the Store Admin role – can edit quotes in the **Quote Details** page as follows:\n\n* Change the price or quantity of each SKU by editing them directly in the **Quoted Price** and **Quantity** columns of the product list within the quote.\n* **Apply Percentage Discount:** apply a percentage discount to the entire quote by dragging the discount bar up to the desired percentage. This will override any changes made to individual product prices.\n* **Expiration Date Change:** change the quote’s expiration date.\n* **Add Note:** write an optional comment.\n\nAfter making any of the above edits on the quote details page, the user must save the quote by clicking `Save quote`.\n\nThis will have the effect of setting the quote’s status to **Ready** and notifying any user who has previously interacted with the quote of the change via email – check [Email templates](#email-templates) for more details on this notification.\n\n\n\n> To take discounts into consideration, the **B2B Quotes and Carts** app is integrated with the [Order Authorization](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-order-authorization-works--3MBK6CmKHAuUjMBieDU0pn) system. If there is a manual discount rule that will automatically deny a discount above a certain percent, **B2B Quotes and Carts** will not allow a discount above this amount to be applied.\n\n#### Requesting additional adjustments to a quote\n\nUsers who lack any of the **Edit** permissions but have any of the **Access** [permissions](#storefront-permissions) can add additional notes to a quote or saved cart if its current status is **Ready**, **Pending**, or **Revised**.\n\nIf a quote is **Ready**, meaning that it has been adjusted and saved by a sales user, its status will change to **Revised** when an organization user adds notes and clicks `Submit to Sales Rep`. This is intended as a way for the organization user to request additional adjustments to pricing or quantity. All users who have previously interacted with the quote will receive a notification including the contents of the notes field – check [Email templates](#email-templates) for more details on this notification.\n\n#### Declining a quote or saved cart\n\nA declined quote or saved cart can no longer be edited or used to place an order. Users with the **Decline Quotes and Carts** [permission](#storefront-permissions) may decline a quote or saved cart if its current status is **Ready**, **Pending** or **Revised**. This can be done by clicking the `Decline` button on the quote details page.\n\nAll users who have previously interacted with the quote will be notified that it has been declined – check [Email templates](#email-templates) for more details on this notification.\n\n#### Using a quote or saved cart to place an order\n\nUsers with the **Place Orders from Quotes and Carts** [permission](#storefront-permissions) may use a quote or saved cart to place an order if its current status is **Ready**, **Pending**, or **Revised**.\n\nThey can do this by clicking the `Use Quote` button on the quote details page. The user will be redirected to checkout with the contents of the quote or saved cart added to their current cart. Anything that was previously in the user’s cart will be cleared.\n\nIf the [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings) app is installed, the checkout will be in a “locked” state until the order is placed, meaning that product quantities cannot be changed, and products cannot be added or removed. If there are not enough items in stock to meet the quantity specified in the quote or saved cart, the amount will be automatically adjusted. If a given product has no availability, checkout will allow it to be removed from the cart.\n\nOnce the order has been placed, the quote or saved cart’s status will automatically change to **Placed**, after which point it cannot be used again.\n\n### Email templates\n\nThe **B2B Quotes & Carts** app provides a set of three email templates to be sent to B2B users, triggered automatically based on specific changes:\n\n| Template name | Recipients | Trigger |\n| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |\n| Quote created | Users with any of the following permissions:Edit My Cost Center's Quotes and CartsEdit My Organization's Quotes and CartsEdit All Quotes and Carts | The quote request was created. |\n| Quote placed | All users who have previously interacted with the quote by editing it, requesting adjustments or approving it. | An order was placed from the existing quote. |\n| Quote updated | All users who have previously interacted with the quote. | The quote was updated in any way – including changes in discounts or expiration dates, new notes added or refusal. |\n\nIf you want to view or edit any of these templates, follow the steps below.\n\n1. In the VTEX Admin, go to **Customer > Message center > Templates**.\n2. In the search bar, type `quote`.\n3. Click on the template you want to view or edit.\n4. Make the desired changes in the template. You can learn more about editing **Message Center** templates by reading our documentation on [How to create and edit transactional email templates](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/335JZKUYgvYlGOJgvJYxRO).\n5. Click on `Save`.\n\n## **Configuration (optional)**\n\nTo change the app’s settings, access **Account Settings** \\> **B2B Quotes** in the VTEX Admin.\n\nOn this page, you can configure the following option:\n\n* **Default expiration period (in days) for quotes and saved carts:** this field allows you to configure the default expiration date for new quotes requested by customers in your store. The default value is 30 days. The minimum value you can set is 1, and there is no maximum value.\n\nMake sure you click on `Save Settings` after any changes.\n\nNote that users with [storefront permissions](#storefront-permissions) to edit quotes will be able to adjust the expiration dates of individual quotes as needed.\n\n\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-b2b-suite/vtex-b2b-quotes.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23installation)\n\n[How the app works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23how-the-app-works)\n\n[My Quotes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23my-quotes)[Creating a quote or saved cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23creating-a-quote-or-saved-cart)[Quote Details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23quote-details)[Email templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23email-templates)\n\n[Configuration (optional)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23configuration-optional)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-b2b-suite/vtex-b2b-quotes.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-b2b-quotes/docs/guides/vtex-b2b-quotes%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23installation)\n\n[How the app works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23how-the-app-works)\n\n[My Quotes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23my-quotes)[Creating a quote or saved cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23creating-a-quote-or-saved-cart)[Quote Details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23quote-details)[Email templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23email-templates)\n\n[Configuration (optional)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes/docs/guides/vtex-b2b-quotes%23configuration-optional)\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_8a8f1219
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore feature navigation in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-overview)\n\nBuilding navigation menus\n\nThis feature enables customers to navigate among the store pages.\n\n## Overview\n\nThis feature aims to group the main store's page header components. These components perform specific functions such as navigation among the store pages, navigation to the login flow and others.\n\n---\n\n## Usage\n\nWe recommend the usage of the components together, keeping the `Navbar` as the wrapper of the others.\n\nThere is an available example of the usage of all the related components in our starter store [here](https://read.calvincode.net/reader?url=https://starter.vtex.app/).\n\n---\n\n## Components\n\n* Storefront \n[Login](#) \nSet location \n * [Office](#) \n * [Home Appliances](#) \n * [Computer and Software](#) \n * [Technology](#) \nNavbar \nRepresents the page header and groups features like Search and Regionalization. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/organisms-navbar)\n* Open Menu \nNavbarSlider \nAs part of the Navbar, this component it its mobile version used to list the navigation links. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/organisms-navbar-slider)\n* Set location \n * [Office](#) \n * [Home Appliances](#) \n * [Computer and Software](#) \n * [Technology](#) \nNavbarLinks \nDisplays a set of navigation links. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/molecules-navbar-links)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/building-navigation-menus.mdx)\n\n[Adding third-party scripts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-handling-third-party-scripts)[Displaying content for authenticated usersNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-building-navigation-menus%23overview)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-building-navigation-menus%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-building-navigation-menus%23components)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/building-navigation-menus.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-building-navigation-menus%23overview)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-building-navigation-menus%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation/docs/guides/faststore/storefront-features-building-navigation-menus%23components)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_dd315172
|
[
{
"role": "system",
"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 optimizing image rendering 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-optimizing-image-rendering/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-optimizing-image-rendering/docs/api-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-optimizing-image-rendering/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-optimizing-image-rendering/docs/storefront-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-optimizing-image-rendering/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-optimizing-image-rendering/docs/troubleshooting)\n\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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/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-optimizing-image-rendering/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/store-framework)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/store-framework-managing-performance)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\nOptimizing image rendering\n\nLearn how to optimize image rendering for faster load times.\n\nThis guide outlines best practices for using images in your [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) to maintain consistency and performance.\n\nImages are crucial for creating a strong brand identity, but if not managed properly, they may slow down your store. To address this, Store Framework offers several image blocks tailored for different purposes, minimizing performance loss and allowing you to display images effectively. Additionally, there are best practices to follow when uploading images in your Store Theme.\n\nThis guide presents the following sections:\n\n* [List of image blocks](#list-of-image-blocks): Presents the VTEX native components available in Store Framework that you can use to optimize image rendering on your store.\n* [Best practices for uploading images](#best-practices-for-uploading-images): Describes best practices to maintain performance and visual consistency when updating images.\n\n## List of image blocks\n\nStore Framework offers several image blocks for different use cases. Selecting the right block helps to maintain performance and visual consistency.\n\n* [**Logo**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo): Renders your brand logo, typically in the header or footer.\n* [**Infocard**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/infocard): Renders images with links and call-to-action (CTA) buttons when you want to guide users with image-based CTAs.\n* [**Rich Text**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text): Renders markdown text when you need to combine text and images in a single block.\n* [**Product Summary Image**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryimage): Renders the product image attached to the product summary information, such as the product name and price. It's commonly used within other store components, like the [Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf), to display products with their key details. \nWhen using the Product Summary block, configure at least one of the following props: \n * `aspectRatio` \n * `width` \n * `height` \n * `maxHeight` \nThese props define image dimensions, ensuring that product summary images are displayed at a consistent size, even if the images uploaded in the catalog have different dimensions. By declaring these props, your store shelf will replicate image consistency across all products being displayed, differently from the shelf example below: \n \n> You don't need to define all four properties in your Product Summary Image block at the same time. Each property has a unique purpose and can be configured based on your needs.\n* [**Image**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/image): Renders standalone images without additional elements such as links or text, for when you just need to display an image.\n\n## Best practices for uploading images\n\nFollow these guidelines to upload images efficiently and avoid performance issues:\n\n* To upload images, use the [Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder) or [Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor). These tools handle cropping automatically, ensuring a consistent user experience across your store.\n* Avoid hardcoding image URLs in the `blocks.json` file, as this can lead to image deformation.\n* Don't use images with large dimensions, as they may not crop correctly in Site Editor, leading to display issues.\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/Perks/best-practices/vtex-io-documentation-optimizing-image-rendering.md)\n\n[Lazy loading components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering//docs/guides/vtex-io-documentation-using-the-fold-blocks)[Improving store accessibility with semantic HTML migrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering//docs/guides/vtex-io-documentation-semantic-html-migration)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[List of image blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-optimizing-image-rendering%23list-of-image-blocks)\n\n[Best practices for uploading images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-optimizing-image-rendering%23best-practices-for-uploading-images)\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-optimizing-image-rendering.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[List of image blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-optimizing-image-rendering%23list-of-image-blocks)\n\n[Best practices for uploading images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering/docs/guides/vtex-io-documentation-optimizing-image-rendering%23best-practices-for-uploading-images)\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_63458521
|
[
{
"role": "system",
"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 order configuration 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.order-configuration/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/api-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.order-configuration/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.order-configuration/docs/storefront-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.order-configuration/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.order-configuration/docs/troubleshooting)\n\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.order-configuration/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/b2b-components)\n\n[Order Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/apps/vtex.order-configuration)\n\n[Quickorder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/apps/vtex.quickorder)\n\n[SKU List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/apps/vtex.sku-list)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/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.order-configuration/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.order-configuration/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/b2b-components)\n\n[Order Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/apps/vtex.order-configuration)\n\n[Quickorder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/apps/vtex.quickorder)\n\n[SKU List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/apps/vtex.sku-list)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/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.order-configuration/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.order-configuration/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.order-configuration/docs/vtex-io-apps)\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/b2b-components)\n\nOrder Configuration\n\nOfficial extension\n\nVersion: 3.3.1\n\nLatest version: 3.3.1\n\n[](#contributors-)\n\nThe **Order Configuration** app, designed for B2B scenarios, displays a form responsible for collecting order data in a modal.\n\n\n\nOnce the form is submitted, the order data collected will be available at Master Data and saved in the current VTEX session.\n\n> This app can be used to enable customization of all kinds of behaviors, such as custom prices, custom products, etc. Keep in mind the Order Configuration app does not offer these functionalities, it only enables other apps to do so.\n\nFollow the steps below to install and set up the **Order Configuration** app in your store.\n\n### Step 1: Install the app\n\nFirst, you must add the `order-configuration` app to your theme's dependencies in the `manifest.json` file:\n\n`1\n\ndependencies: { \n\n2\n\n \"vtex.order-configuration\": \"2.x\" \n\n3\n\n} \n\n`\n\nThis will enable you to use the blocks exported by the `order-configuration` app. Check out the full list below:\n\n| Block name | Description |\n| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| order-config | Parent block only responsible for rendering its children blocks, that in turn build the Order Configuration component. |\n| order-config.title | Renders the component title, that is, the message text displayed for users to present the component. On the image above, the component title is Order Configuration. |\n| order-config.modal | Renders the modal responsible for displaying the component content. |\n| order-config.form | Renders the component content, that is, a form to be filled out by users. |\n\n### Step 2: Declare the required blocks\n\nAdd the `order-config` block in the Header component, as shown in the example below.\n\n`1\n\n{ \n\n2\n\n \"header-layout.desktop\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#1-desktop\", \n\n5\n\n \"flex-layout.row#2-desktop\", \n\n6\n\n \"flex-layout.row#3-desktop\", \n\n7\n\n \"sticky-layout#4-desktop\" \n\n8\n\n ] \n\n9\n\n }, \n\n10\n\n \"flex-layout.row#3-desktop\": { \n\n11\n\n \"props\": { \n\n12\n\n \"blockClass\": \"menu-link\", \n\n13\n\n \"horizontalAlign\": \"center\", \n\n14\n\n \"preventHorizontalStretch\": true, \n\n15\n\n \"preventVerticalStretch\": true, \n\n16\n\n \"fullWidth\": true \n\n17\n\n }, \n\n18\n\n \"children\": [ \n\n19\n\n \"vtex.menu@2.x:menu#websites\", \n\n20\n\n \"flex-layout.col#spacer\", \n\n21\n\n+ \"order-config#header\", \n\n22\n\n \"vtex.menu@2.x:menu#institutional\" \n\n23\n\n ] \n\n24\n\n }, \n\n`\n\nThen, declare the `order-config#header` block and its children blocks: `order-config.title` and `order-config.modal`. Example:\n\n`1\n\n{ \n\n2\n\n \"order-config#header\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"order-config.title#header\", \n\n5\n\n \"order-config.modal#header\" \n\n6\n\n ], \n\n7\n\n \"props\": { \n\n8\n\n \"blockClass\": \"header\", \n\n9\n\n \"formFields\": [ \n\n10\n\n { \n\n11\n\n \"name\": \"orderType\", \n\n12\n\n \"type\": \"string\", \n\n13\n\n \"fieldType\": \"radio\", \n\n14\n\n \"label\": \"Order Type\", \n\n15\n\n \"defaultValue\": \"resale\", \n\n16\n\n \"options\": [ \n\n17\n\n { \n\n18\n\n \"label\": \"Resale\", \n\n19\n\n \"value\": \"resale\" \n\n20\n\n }, \n\n21\n\n { \n\n22\n\n \"label\": \"Consumption\", \n\n23\n\n \"value\": \"consumption\" \n\n24\n\n } \n\n25\n\n ] \n\n26\n\n }, \n\n27\n\n { \n\n28\n\n \"name\": \"state\", \n\n29\n\n \"type\": \"string\", \n\n30\n\n \"fieldType\": \"select\", \n\n31\n\n \"label\": \"State\", \n\n32\n\n \"showInTitle\": true, \n\n33\n\n \"options\": [ \n\n34\n\n { \n\n35\n\n \"label\": \"ES\", \n\n36\n\n \"value\": \"ES\" \n\n37\n\n }, \n\n38\n\n { \n\n39\n\n \"label\": \"SP\", \n\n40\n\n \"value\": \"SP\" \n\n41\n\n } \n\n42\n\n ] \n\n43\n\n } \n\n44\n\n ] \n\n45\n\n } \n\n46\n\n }, \n\n47\n\n \"order-config.modal#header\": { \n\n48\n\n \"children\": [ \n\n49\n\n \"order-config.form\" \n\n50\n\n ] \n\n51\n\n }, \n\n52\n\n \"order-config.title#header\": { \n\n53\n\n \"props\": { \n\n54\n\n \"formTitle\": \"Order Configuration for Header\" \n\n55\n\n } \n\n56\n\n }, \n\n57\n\n} \n\n`\n\n> If the `order-config.form` block does not have any children configured, a default form will be rendered automatically based on the [React Hook Form JSON Schema](https://read.calvincode.net/reader?url=https://github.com/vtex/react-hook-form-jsonschema) library. To declare children blocks according to your business needs, check out the [Advanced configuration](#advanced-configuration) section below.\n\n### Step 3: Create `main` schema in Master Data\n\nYou must create a schema named `main` in Master Data, using the `order_configuration` data entity.\n\nYou can place a request using the Save schema by name endpoint of the [Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/schemas%23saveschemabyname) to do so.\n\nThe schema should contain all the data that you added in the form above, otherwise the data will not be persisted.\n\n#### Request body example\n\n`1\n\n{ \n\n2\n\n \"v-cache\": false, \n\n3\n\n \"properties\": { \n\n4\n\n \"clientId\": { \n\n5\n\n \"type\": \"string\" \n\n6\n\n }, \n\n7\n\n \"orderType\": { \n\n8\n\n \"type\": \"string\" \n\n9\n\n }, \n\n10\n\n \"state\": { \n\n11\n\n \"type\": \"string\" \n\n12\n\n } \n\n13\n\n }, \n\n14\n\n \"v-default-fields\": [ \n\n15\n\n \"clientId\", \n\n16\n\n \"orderType\", \n\n17\n\n \"state\" \n\n18\n\n ], \n\n19\n\n \"v-indexed\": [ \n\n20\n\n \"clientId\", \n\n21\n\n \"orderType\", \n\n22\n\n \"state\" \n\n23\n\n ] \n\n24\n\n} \n\n`\n\nRefer to [Master Data API - v2 documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/schemas%23saveschemabyname) for more details.\n\n### Step 4: Update orderForm configuration\n\nIt is also necessary to configure a new app in the `orderForm`.\n\nFirst, place a `GET` [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/reference/getorderformconfiguration) request to retrieve the current `orderForm` settings before updating them. By doing so you ensure that you will only change the properties you want in the next step.\n\nThen, place a `POST` [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/reference/updateorderformconfiguration) request, setting the following object inside the `apps` object in the request body:\n\n`1\n\n { \n\n2\n\n \"fields\": [ \n\n3\n\n \"values\" \n\n4\n\n ], \n\n5\n\n \"id\": \"orderconfig\", \n\n6\n\n \"major\": 1 \n\n7\n\n } \n\n`\n\n#### Request body example\n\n`1\n\n{ \n\n2\n\n \"paymentConfiguration\": { \n\n3\n\n \"requiresAuthenticationForPreAuthorizedPaymentOption\": false, \n\n4\n\n \"allowInstallmentsMerge\": null, \n\n5\n\n \"blockPaymentSession\": null, \n\n6\n\n \"paymentSystemToCheckFirstInstallment\": null, \n\n7\n\n \"defaultPaymentSystemToApplyOnUserOrderForm\": null \n\n8\n\n }, \n\n9\n\n \"taxConfiguration\": null, \n\n10\n\n \"minimumQuantityAccumulatedForItems\": 1, \n\n11\n\n \"decimalDigitsPrecision\": 2, \n\n12\n\n \"minimumValueAccumulated\": null, \n\n13\n\n \"apps\": [ \n\n14\n\n { \n\n15\n\n \"fields\": [ \n\n16\n\n \"quoteId\" \n\n17\n\n ], \n\n18\n\n \"id\": \"b2b-quotes-graphql\", \n\n19\n\n \"major\": 1 \n\n20\n\n }, \n\n21\n\n { \n\n22\n\n \"fields\": [ \n\n23\n\n \"values\" \n\n24\n\n ], \n\n25\n\n \"id\": \"orderconfig\", \n\n26\n\n \"major\": 1 \n\n27\n\n } \n\n28\n\n ], \n\n29\n\n \"allowMultipleDeliveries\": true, \n\n30\n\n \"allowManualPrice\": true, \n\n31\n\n \"maxNumberOfWhiteLabelSellers\": null, \n\n32\n\n \"maskFirstPurchaseData\": null, \n\n33\n\n \"recaptchaValidation\": \"vtexcriteria\", \n\n34\n\n \"maskStateOnAddress\": true \n\n35\n\n} \n\n`\n\nYou can refer to [Checkout API documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/reference/updateorderformconfiguration) for more information.\n\n### Advanced configuration\n\nIf desired, you can declare the `order-config.form` block by adding and configuring the `formFields` prop and an array of form children blocks (whose descriptions you can find below).\n\n`1\n\n{ \n\n2\n\n \"order-config#static-page\": { \n\n3\n\n \"props\": { \n\n4\n\n \"formFields\": [ \n\n5\n\n { \n\n6\n\n \"name\": \"orderType\", \n\n7\n\n \"type\": \"string\", \n\n8\n\n \"fieldType\": \"select\", \n\n9\n\n \"label\": \"Order Type\", \n\n10\n\n \"defaultValue\": \"res\", \n\n11\n\n \"showInTitle\": true, \n\n12\n\n \"options\": [ \n\n13\n\n { \n\n14\n\n \"label\": \"Resale\", \n\n15\n\n \"value\": \"res\" \n\n16\n\n }, \n\n17\n\n { \n\n18\n\n \"label\": \"Consumption\", \n\n19\n\n \"value\": \"cons\" \n\n20\n\n } \n\n21\n\n ] \n\n22\n\n }, \n\n23\n\n { \n\n24\n\n \"name\": \"state\", \n\n25\n\n \"type\": \"string\", \n\n26\n\n \"fieldType\": \"select\", \n\n27\n\n \"label\": \"State\", \n\n28\n\n \"showInTitle\": true, \n\n29\n\n \"required\": true, \n\n30\n\n \"options\": [ \n\n31\n\n { \n\n32\n\n \"label\": \"ES\", \n\n33\n\n \"value\": \"ES\" \n\n34\n\n }, \n\n35\n\n { \n\n36\n\n \"label\": \"SP\", \n\n37\n\n \"value\": \"SP\" \n\n38\n\n } \n\n39\n\n ] \n\n40\n\n }, \n\n41\n\n { \n\n42\n\n \"name\": \"someTextInput\", \n\n43\n\n \"label\": \"Some Text Input\", \n\n44\n\n \"fieldType\": \"input\", \n\n45\n\n \"type\": \"string\", \n\n46\n\n \"required\": true, \n\n47\n\n \"showInTitle\": true \n\n48\n\n } \n\n49\n\n ] \n\n50\n\n }, \n\n51\n\n \"children\": [ \n\n52\n\n \"order-config.title#static-page\", \n\n53\n\n \"order-config.form#static-page\" \n\n54\n\n ] \n\n55\n\n }, \n\n56\n\n \"order-config.form#static-page\": { \n\n57\n\n \"children\": [ \n\n58\n\n \"flex-layout.row#state-and-payment-method\", \n\n59\n\n \"order-config.text#some-text-input\", \n\n60\n\n \"order-config.submit\" \n\n61\n\n ] \n\n62\n\n }, \n\n63\n\n \"flex-layout.row#state-and-payment-method\": { \n\n64\n\n \"children\": [ \n\n65\n\n \"order-config.dropdown#state\", \n\n66\n\n \"order-config.radiogroup#payment-method\" \n\n67\n\n ], \n\n68\n\n \"props\": { \n\n69\n\n \"blockClass\": \"stateAndPaymentMethod\" \n\n70\n\n } \n\n71\n\n }, \n\n72\n\n \"order-config.dropdown#state\": { \n\n73\n\n \"props\": { \n\n74\n\n \"pointer\": \"#/properties/state\" \n\n75\n\n } \n\n76\n\n }, \n\n77\n\n \"order-config.radiogroup#payment-method\": { \n\n78\n\n \"props\": { \n\n79\n\n \"pointer\": \"#/properties/paymentMethod\" \n\n80\n\n } \n\n81\n\n }, \n\n82\n\n \"order-config.text#some-text-input\": { \n\n83\n\n \"props\": { \n\n84\n\n \"pointer\": \"#/properties/someTextInput\" \n\n85\n\n } \n\n86\n\n }, \n\n87\n\n \"order-config.title#static-page\": { \n\n88\n\n \"props\": { \n\n89\n\n \"formTitle\": \"Order Configuration for Static Page\" \n\n90\n\n } \n\n91\n\n } \n\n92\n\n} \n\n`\n\n| Block name | Description |\n| ----------------------- | ---------------------------------------------------------------- |\n| order-config.submit | Renders a Submit button. |\n| order-config.dropdown | Renders the a dropdown field. |\n| order-config.radiogroup | Renders a radiogroup field. |\n| order-config.text | Renders a text field. |\n| order-config.textarea | Renders a text field with a wider range of available characters. |\n| order-config.checkbox | Renders a checkbox field. |\n\n#### Props\n\nCheck out the description of the available props below.\n\n| Prop name | Type | Description | Default Value | Block name |\n| ---------- | ------ | ------------------------------------------------------------------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------- |\n| pointer | string | Path to which the block must point in the formFields prop in order to properly work. | undefined | order-config.dropdown, order-config.radiogroup, order-config.text, order-config.textarea, and order-config.checkbox |\n| formFields | object | Object responsible for defining the form fields. | undefined | order-config.form |\n\nThe `formFields` object contains the following props:\n\n| Prop name | Type | Description | Default Value |\n| ----------- | ------- | ---------------------------------------------------------------------------------------------------------- | ------------- |\n| name | string | Name of the field (only used as an identifier in your code). | undefined |\n| type | enum | Value type accepted by the field. Possible values are string and number. | string |\n| fieldType | enum | Input type accepted by the field. Possible values are: text, textarea, select, radio, and checkbox. | text |\n| label | string | Field name shown to users. | undefined |\n| showInTitle | boolean | Whether to display the value type accepted by the field on its name (true) or not (false). | false |\n| options | object | Field options to be defined in case select, radio, or checkbox values were declared in the fieldType prop. | undefined |\n\nThe `options` object contains the following props:\n\n| Prop name | Type | Description | Default Value |\n| --------- | ------ | --------------------------- | ------------- |\n| label | string | Option name shown to users. | undefined |\n| value | string | Option value. | undefined |\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| formSubmitButton |\n| formSubmitContainer |\n| formErrorServer |\n| formErrorUserInput |\n| loader |\n| orderConfigFormWrapper |\n| formObject |\n| title |\n| titleValues |\n| titleWrapper |\n| wrapper |\n\n[B2B components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/guides/b2b-components)[QuickorderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/apps/vtex.quickorder)\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[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-configuration/docs/apps/vtex.order-configuration%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_bd56f55d
|
[
{
"role": "system",
"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 developing custom storefront components in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/create-master-data-crud-app)\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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/create-master-data-crud-app)\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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/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-developing-custom-storefront-components/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\nDeveloping custom storefront components\n\nDuring the development process, it is normal to face critical questions regarding performance and internationalization, among other issues that directly affect the shopping experience.\n\nAlthough **VTEX does not offer any support for custom projects**, we have put together the guidelines adopted by our own product team to help your development journey using Store Framework, VTEX IO, and the React technology.\n\nBelow you can find the best practices for tooling, features, flexibility, scalability, performance, accessibility, internationalization, and styling that you can adopt when creating your storefront component.\n\n> Before applying the settings below, it is highly recommended that you understand how VTEX IO, Store Framework, and React work since the guidelines assume previous knowledge. You can dive deeper in [VTEX IO learning course](https://read.calvincode.net/reader?url=https://learn.vtex.com/) and the [React official documentation](https://read.calvincode.net/reader?url=https://reactjs.org/) for help.\n\n## Tooling\n\nWhen creating a custom component, use tools to facilitate code development by automatically formatting and testing it.\n\nFeatures such as [ESLint](https://read.calvincode.net/reader?url=https://eslint.org/), [Typescript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/), and [Prettier](https://read.calvincode.net/reader?url=https://prettier.io/) are not mandatory for project deployment, but they help development, code maintenance, and testing.\n\nThe [React App repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/react-app-template) is the go-to model template for tooling since it provides formatting features alongside the [VTEX Test Tool](https://read.calvincode.net/reader?url=https://github.com/vtex/test-tools), a native VTEX testing tool that leverages [Jest](https://read.calvincode.net/reader?url=https://jestjs.io/).\n\nUse Typescript types as an ally in your development journey since they provide autocomplete tools that can be used when developing and importing a new component. To have them handy, run the following command in your terminal:\n\n`1\n\nvtex setup --typings \n\n`\n\n> The above command will install all Typescript types from the apps listed in the app `dependencies` list in your project. Whenever you add a new dependency, the command must be run again.\n\n## Feature development\n\n### Store-specific\n\nIn an attempt to reuse code, one common mistake is to design a component that tries to perform multiple tasks.\n\nEnsure you maintain a clear focus on the primary objective of the component. It is crucial to be as precise as possible in defining this goal.\n\nKeep it simple. Components with several functionalities tend to mislead users in the interface and translate to a lot of code to manage behind the scenes, especially when handling APIs.\n\n### Native-first\n\nBefore developing a custom component from scratch, make sure VTEX does not already offer the same feature natively through the [Store Framework native components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps).\n\nCreate your component importing and combining native components to achieve a better result. For example:\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { ProductSummaryList } from 'vtex.product-summary' \n\n3\n\n \n4\n\ninterface Props { \n\n5\n\n title?: string \n\n6\n\n} \n\n7\n\n \n8\n\nfunction Shelf({ title }: Props) { \n\n9\n\n return ( \n\n10\n\n <div> \n\n11\n\n <h3>{title}</h3> \n\n12\n\n <ProductSummaryList /> \n\n13\n\n </div> \n\n14\n\n ) \n\n15\n\n} \n\n16\n\n \n17\n\nexport default Shelf \n\n`\n\n> Notice how the Store Framework solution relies on specific apps for [integrations with third-party solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe) and [layout structuring](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout), besides having template components that play a particular role once rendered to the end users, such as the [Product Identifier app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier). When developing your storefront component, remember that segmentation is key to light code and a successful component.\n\n## Flexibility and scalability\n\n### Rendering\n\nYour component should have the flexibility to handle all possible scenarios once rendered.\n\nBe careful not to get hyperfocused on its appearance when fully rendered. It is important to consider all other possible statuses during the rendering process, such as:\n\n* `Loading` \\- When the component is already visible to users but not fully rendered due to data loading.\n* `Error` \\- When the component cannot be rendered due to an error.\n* `Empty` \\- When the component cannot fetch data and is rendered with empty content.\n\n> Render Runtime is the VTEX app that renders the storefront. Read the [app documentation](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/render-runtime) and get to know some valuable variables for your project.\n\nAlso, be careful when using browser variables, such as `window` and `document`, since they only exist in the browser context and may affect your component display when opting for server-side rendering.\n\nBefore implementing your component, check which variables are available on the browser using the [Render Runtime](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/render-runtime%23canusedom) `canUseDom` variable.\n\n### Browser compatibility\n\nThe VTEX IO platform automatically provides JavaScript polyfills for implementing features on web browsers that cannot do that.\n\nAlthough this practice ensures the good performance of your component in several user agents, you may be working with NPM libraries that cannot be implemented in old web browsers.\n\nCheck which web browsers are more common among your audience and focus on those when developing your storefront component. For example, some stores are still IE11-oriented, even though it is not as widely used anymore.\n\n### Prop substitution\n\nThe simplicity of boolean props, with switch component behaviors `true` and `false`, makes them easy to use in React projects.\n\nHowever, they do not offer great scalability when taking into account that the component evolution may require a third (or more) behavior to be enabled.\n\nBoolean props, therefore, demand creating brand-new props whenever unprecedented use cases are introduced to your component.\n\n> Once the component is deployed, avoid modifying its props (creating, removing, and/or updating them). Modifying props can be costly because it can directly impact API maintenance and affect other developers working with it.\n\nWith that in mind, replace the boolean props with enum props. The latter has a broader range and is more adapted to keep up with the component evolution and the several behaviors it may have to handle.\n\nFor example:\n\n| Do not use | Use | |\n| ---------- | ------------- | --------------- |\n| Prop name | show | visibility |\n| Values | true or false | visible or none |\n\nTo ensure long-term compatibility and resilience of the component, it is recommended to use enum props during development.\n\n### Responsive values\n\nOne of the critical points of flexibility and scalability is having a component that is ready to be displayed on any possible device.\n\nInstead of creating specific props to handle typical device scenarios, leverage the [VTEX Responsive Values app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/responsive-values) to enable the component props to accept different values from devices, such as desktop and mobile.\n\n| ✅ Do | ❌ Don't |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|  |  |\n\n> Combine enum props with responsive values, as shown below, and enhance code quality with highly optimized props!\n\n\n\n### Slots\n\nSlots allow you to render components through props instead of declaring an array of blocks in the Store Theme. Its simplicity removes the need for the `allowed` property in the [interface](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface) file and lightens your code, increasing flexibility when developing a new storefront component.\n\nYou can learn more about Slots [here](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots).\n\n| ✅ Use | ❌ Do not use |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|  |  |\n\n> If you are not using Slots, we recommend using the `children` [composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition).\n\n## Performance\n\nIn the digital world, store website performance plays an essential role in the user experience, directly impacting the sales conversion rate and user session time, among other important metrics.\n\nIn addition to the practices listed below, do not forget to read our documentation on [optimizing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance) to enable advanced configurations and boost the performance of your store.\n\n### NPM libraries\n\nAvoid using heavy npm libraries because they negatively impact page loading time and can affect the user experience.\n\nChoose light libraries to support your code and optimize performance.\n\n> Evaluate the impact of npm libraries on user experience at [bundlephobia.com](https://read.calvincode.net/reader?url=https://bundlephobia.com/).\n\n### Data sharing\n\nUse the React context to share data between components and avoid over-fetching at all costs.\n\nThe Dispatcher and State patterns, as well as the useMemo feature, are powerful resources that can be made available by the context and used by your component.\n\n> Read the article on [using the React context effectively](https://read.calvincode.net/reader?url=https://kentcdodds.com/blog/how-to-use-react-context-effectively) for a detailed explanation about how the React context can work in your favor.\n\n### Media upload\n\nUsing media in storefront components can be tricky if you do not think about performance critically.\n\nWhen [uploading the desired media assets to the VTEX File Server](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-assets-builder), clearly define height and width parameters to avoid data over-fetching and resizing on the client-side. This way, you can set up your component to request media assets based on the required size per breaking point.\n\n### Rendering\n\nPerformance can be optimized during component rendering as well.\n\nWhen declaring the [interface](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface) of a block, set the `Hydration` attribute and pass `on-view` as its value to only load and correctly render your component once users find it on the interface.\n\nThe [Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer) is a good example of a Store Framework native component that uses this attribute.\n\n> The default value for `Hydration` is `always`, meaning that the component will be loaded and rendered as expected, regardless of the user's view.\n\n## Accessibility\n\nPrioritizing accessibility leads to an excellent opportunity to bring more users closer to the store's shopping experience.\n\nAdopt the following practices to promote inclusion:\n\n* Enable user interactivity through the keyboard.\n* Bet on color contrast when defining the component style. You can use the [ChromeLens extension](https://read.calvincode.net/reader?url=http://chromelens.xyz/) to help you with that.\n* Avoid the usage of HTML div to enhance accessibility for screen readers and improve search engine optimization.\n\n## Internationalization\n\nYour component should be ready to be displayed worldwide if store globalization is a goal.\n\nIn terms of content internationalization, be cautious with string text translations. You can leverage the Messages app, a native VTEX IO service for automatic translations, and have manual translations as well.\n\nRemember that internationalization can mean more than string text translations. Consider interpolation, pluralization, price, and percentage formatting, among other differences that may come your way when crossing borders.\n\nRead the [Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component) article and the [multi-language store documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores) to understand how you can make these adjustments in your component!\n\n## Styling\n\nStyle customization is one of the main steps when building a page template and developing storefront components.\n\nUse Tachyons instead of CSS Modules whenever possible when applying CSS to your project. The Tachyons solution is usually better for different storefront scenarios. CSS Modules, on the other hand, have use restrictions depending on the component behavior.\n\nGet acquainted with the particularities of both tools to make the best decision for the component style without wasting development efforts.\n\nAlso, do not forget to make CSS handles available to your component users if distribution at the VTEX App Store is a goal. Through CSS handles, future developers can style your storefront component based on their specific needs.\n\nRead the documentation on [Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-defining-styles) to learn about Tachyons, CSS Modules, and CSS handles, as well as their use cases.\n\nAnother good styling tip is to be careful with the breakpoints on the screen for different devices. Remember to set the component style for every possible scenario on the interface!\n\n> The [VTEX Styleguide](https://read.calvincode.net/reader?url=https://styleguide.vtex.com/) is a go-to document during style customization. Our team constantly updates the guide and provides valuable design guidelines.\n\n## Engagement\n\nFinally, the best practice you can adopt is keeping up with the VTEX IO platform! Engage with us:\n\n* Follow the [Developer Portal's release notes feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes).\n* Subscribe to the [VTEX Developer Newsletter](https://read.calvincode.net/reader?url=https://forms.gle/DHo3SS7ZaGCvAMow8).\n* Follow our [YouTube channel](https://read.calvincode.net/reader?url=https://www.youtube.com/@VTEXDevelopers) for developers.\n* Join the [Community](https://read.calvincode.net/reader?url=https://community.vtex.com/).\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-developing-custom-storefront-components.md)\n\n[9\\. Making your app publicly available« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components//docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)[Pixel appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components//docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Tooling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23tooling)\n\n[Feature development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23feature-development)\n\n[Store-specific](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23store-specific)[Native-first](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23native-first)\n\n[Flexibility and scalability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23flexibility-and-scalability)\n\n[Rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23rendering)[Browser compatibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23browser-compatibility)[Prop substitution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23prop-substitution)[Responsive values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23responsive-values)[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23slots)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23performance)\n\n[NPM libraries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23npm-libraries)[Data sharing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23data-sharing)[Media upload](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23media-upload)[Rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23rendering)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23accessibility)\n\n[Internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23internationalization)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23styling)\n\n[Engagement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23engagement)\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-developing-custom-storefront-components.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Tooling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23tooling)\n\n[Feature development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23feature-development)\n\n[Store-specific](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23store-specific)[Native-first](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23native-first)\n\n[Flexibility and scalability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23flexibility-and-scalability)\n\n[Rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23rendering)[Browser compatibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23browser-compatibility)[Prop substitution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23prop-substitution)[Responsive values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23responsive-values)[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23slots)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23performance)\n\n[NPM libraries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23npm-libraries)[Data sharing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23data-sharing)[Media upload](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23media-upload)[Rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23rendering)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23accessibility)\n\n[Internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23internationalization)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23styling)\n\n[Engagement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components/docs/guides/vtex-io-documentation-developing-custom-storefront-components%23engagement)\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_04d3824d
|
[
{
"role": "system",
"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 deactivating the vtex io native service worker 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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/docs/api-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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/docs/storefront-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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/docs/troubleshooting)\n\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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/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-deactivating-the-vtex-io-native-service-worker/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/store-framework)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\nDeactivating the VTEX IO native service worker\n\nAll stores built on the Store Framework include a native [Service Worker](https://read.calvincode.net/reader?url=https://developers.google.com/web/fundamentals/primers/service-workers). This service worker is integral to enabling your store to operate as a Progressive Web App (PWA), enhancing user experience by providing features like offline navigation, faster loading times, and the ability to add the store to the home screen.\n\nWhile the native service worker greatly enhances the functionality of your store, you may find it necessary to integrate third-party services that also require their own service workers. Since a website can only support a single active service worker, conflicts may arise. In such cases, you have the option to deactivate the VTEX IO native service worker, allowing you to implement your desired third-party solution successfully.\n\n## Instructions\n\n1. Access the Admin.\n2. Navigate to **Store Settings > Storefront > Store**.\n3. Click the `Advanced` tab.\n4. Enable the `Service Worker` option to deactivate the native service worker. \n\n5. Save your changes.\n\nOnce you save the changes, the VTEX Service Worker will be automatically disabled, allowing your store to function with the third-party service worker.\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/boosting-performance/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker.md)\n\n[Managing performance« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker//docs/guides/store-framework-managing-performance)[Debugging performance issuesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker//docs/guides/vtex-io-documentation-debugging-performance-issues)\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-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker%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/boosting-performance/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker.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-deactivating-the-vtex-io-native-service-worker/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker%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_895d8e43
|
[
{
"role": "system",
"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 store framework 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-store-framework/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-store-framework/docs/api-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-store-framework/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-store-framework/docs/storefront-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-store-framework/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-store-framework/docs/troubleshooting)\n\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-store-framework/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework/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-store-framework/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-store-framework/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-store-framework/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-store-framework/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-store-framework/updates/release-notes)\n\nWhat is VTEX Store Framework\n\nWhen comparing two or more online stores, we can notice similarities in their structure. For instance, regardless of the store, it's common to see products highlighted in the window display, a search bar, menus, product pages with a buy button, a logo, etc.\n\nThese commonalities suggest that **online store components are intertwined**, and this makes the process of creating a store easier.\n\nFrontend development can be done using a **single, shareable component structure** among stores, and this is where Store Framework comes into play.\n\n## Delivering the foundation needed for any storefront structure\n\nThe VTEX Store Framework is built on the [VTEX IO development platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) and [React](https://read.calvincode.net/reader?url=https://reactjs.org/) technology, and it is responsible for building the storefront by offering native ecommerce components in JSON format.\n\nOur components allow you to:\n\n* Build your store frontend in the **fastest possible go-to-market**.\n* Have **comprehensive shopping experiences** that never get old.\n* Adapt these experiences to match your store's unique identity since they are highly **flexible** and allow for **high customization**.\n* Enjoy native **integration with VTEX APIs**.\n* Easily track your store view events through **analytic tools**, such as Google Tag Manager and Google Analytics.\n* Connect and collaborate with other developers, ask questions and share your knowledge at the VTEX Community.\n* **Standardize the way your team develops** frontend code.\n\nNow that you know what VTEX Store Framework is, dive deeper into it: read the answers to the most [frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions) and take a look at some of our [components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps).\n\nIf you're planning to build your storefront using our components, don't hesitate to access our documentation on how to [build a store using Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3).\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-store-framework.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Delivering the foundation needed for any storefront structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework/docs/guides/vtex-io-documentation-what-is-vtex-store-framework%23delivering-the-foundation-needed-for-any-storefront-structure)\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-store-framework.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Delivering the foundation needed for any storefront structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework/docs/guides/vtex-io-documentation-what-is-vtex-store-framework%23delivering-the-foundation-needed-for-any-storefront-structure)\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_69adb9ac
|
[
{
"role": "system",
"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 share 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/share/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/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/apps/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/apps/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/apps/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/apps/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/apps/vtex.store-components/share/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/share/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/share/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/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/share/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/share/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/share/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/share/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/share/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/share/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/share/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/share/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/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/share/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/share/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/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/share/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/share/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/share/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/share/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/share/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/share/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/share/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/share/docs/vtex-io-apps)\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/guides/store-components)\n\nShare\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 `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/vtex-developer-docs/docs/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\n[Search Bar« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/searchbar)[Shipping SimulatorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/shippingsimulator)\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/share/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/share/docs/apps/vtex.store-components/share%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/share%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share/docs/apps/vtex.store-components/share%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_93b7bcff
|
[
{
"role": "system",
"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 metadata information in payment transactions 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/metadata-information-in-payment-transactions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/api-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/metadata-information-in-payment-transactions/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/metadata-information-in-payment-transactions/docs/storefront-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/metadata-information-in-payment-transactions/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/metadata-information-in-payment-transactions/docs/troubleshooting)\n\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/metadata-information-in-payment-transactions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/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/metadata-information-in-payment-transactions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/payments-configuration-guides)\n\n[Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/setting-up-the-type-of-interest-rate)\n\n[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/setting-up-merchant-id-in-apple-pay)\n\n[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/cardholder-document-configuration)\n\n[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)\n\n[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/metadata-information-in-payment-transactions)\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/metadata-information-in-payment-transactions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/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/metadata-information-in-payment-transactions/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/metadata-information-in-payment-transactions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/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/metadata-information-in-payment-transactions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/payments-configuration-guides)\n\n[Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/setting-up-the-type-of-interest-rate)\n\n[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/setting-up-merchant-id-in-apple-pay)\n\n[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/cardholder-document-configuration)\n\n[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)\n\n[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/metadata-information-in-payment-transactions)\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/metadata-information-in-payment-transactions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/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/metadata-information-in-payment-transactions/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/metadata-information-in-payment-transactions/docs/guides)\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/payments-configuration-guides)\n\n[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/metadata-information-in-payment-transactions)\n\nMetadata information in payment transactions\n\nAt VTEX, payment providers have the option of using [Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol) (PPP) endpoints to record additional information that they consider essential for processing a transaction. This can include data related to orders or other platform modules, payment identifiers created by the provider, and internal operations logs.\n\nTo use this functionality, it is necessary to create metadata information fields on the PPP endpoints.\n\n## Adding metadata information to your payment transactions\n\nTo use metadata in the provider's payment transactions, follow the steps below:\n\n1. Update the provider manifest to include the `metadataFields` array and forward it to VTEX. This array must contain a maximum of 3 strings, each with a maximum length of 20 characters, which will represent the names of the metadata fields to be sent by the provider. See an example below:\n\n`1\n\n... \n\n2\n\n\"metadataFields\": [ \n\n3\n\n \"MetadataName1\", \n\n4\n\n \"MetadataName2\" \n\n5\n\n ] \n\n6\n\n... \n\n`\n\n1. Add the `connectorMetadata` array to the request body of the following endpoints ([Create Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments), [Cancel Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/cancellations), [Settle Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/settlements), [Refund Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/refunds) and [Inbound Request (BETA)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/inbound/-action-)). The array must contain the following information: \n * `name`: string that identifies the name of the metadata field inserted in the provider manifest (maximum limit of 20 characters). \n * `value`: string containing the metadata (maximum limit of 200 characters).\n\nSee an example below:\n\n`1\n\n... \n\n2\n\n\"connectorMetadata\": [ \n\n3\n\n { \n\n4\n\n \"name\": \"MetadataName1\", \n\n5\n\n \"value\": \"MetadataValue1\" \n\n6\n\n }, \n\n7\n\n { \n\n8\n\n \"name\": \"MetadataName2\", \n\n9\n\n \"value\": \"MetadataValue2\" \n\n10\n\n }, \n\n11\n\n] \n\n12\n\n... \n\n`\n\n1. After sending one of the endpoint requests from the previous step, the response body will return the payment and metadata information, indicating that they were stored in the VTEX gateway. See an example of the response body from the [Refund Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/refunds) endpoint.\n\n`1\n\n{ \n\n2\n\n \"paymentId\": \"F5C2A4E21D3B4E09B7E871F5B6BC9F91\", \n\n3\n\n \"refundId\": \"2EA324981E7E4BCC9F9D7B46874C2594\", \n\n4\n\n \"value\": 57, \n\n5\n\n \"code\": null, \n\n6\n\n \"message\": \"Successfully refunded\", \n\n7\n\n \"requestId\": \"LB4E40D3B4G07B7B871F5B4BC3F31\", \n\n8\n\n \"connectorMetadata\": [ \n\n9\n\n { \n\n10\n\n \"name\": \"MetadataName1\", \n\n11\n\n \"value\": \"MetadataValue1\" \n\n12\n\n }, \n\n13\n\n { \n\n14\n\n \"name\": \"MetadataName2\", \n\n15\n\n \"value\": \"MetadataValue2\" \n\n16\n\n } \n\n17\n\n ] \n\n18\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Payments/payments-configuration-guides/metadata-information-in-payment-transactions.md)\n\n[Implementing a pre-analysis anti-fraud flow for debit card transactions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions//docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)[Feed v3Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions//docs/guides/orders-feed)\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Adding metadata information to your payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/metadata-information-in-payment-transactions%23adding-metadata-information-to-your-payment-transactions)\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/Payments/payments-configuration-guides/metadata-information-in-payment-transactions.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Adding metadata information to your payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions/docs/guides/metadata-information-in-payment-transactions%23adding-metadata-information-to-your-payment-transactions)\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_3c259736
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore getting started structuring content types and 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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\n[Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\n[Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\n[Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\n[Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-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/getting-started-structuring-content-types-and-sections/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-overview)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\nStructuring Content Types and Sections\n\nStructure Content Types and Sections with JSON Schema for rich CMS editing.\n\nNow that you have created your `cms` folder and have an overall understanding of how you'll use it, let's learn how to structure the Content Type and Section files so you can create any integrations you desire.\n\n## What you'll accomplish\n\nBy the end of this step, you will have:\n\n* Learned how to structure Content Types with configuration schema sets\n* Understood how to define Sections with JSON Schema for editor forms\n* Gained knowledge of widgets and UI schemas for rich content editing\n* Developed the skills to create complex Content Types and Sections independently\n\nThis knowledge enables you to build custom content management workflows tailored to your store's needs.\n\n## Step 1: Automatically syncing your changes\n\n1. Before creating more complex definitions of Content Types and Sections, go to the root of your FastStore project and run `yarn dev` to enable the FastStore CLI watch mode. Make sure to use a development workspace.\n\n> This command will monitor any changes in the project, including the new section you have created, and automatically merge it with the default sections available in [faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview).\n\n1. Open another terminal and run `faststore cms-sync` to automatically sync your changes in the `cms` folder with the Headless CMS app.\n2. Open the **VTEX Admin**, access **Storefront > Headless CMS** and keep it next to your code to see your changes while editing the `cms` folder. Refreshing the Admin may be necessary to see your changes.\n\n## Step 2: Adding Content Types to the Headless CMS\n\nThe `content-types.json` file is an array of JSON objects that describes the types of pages available for customization at the Headless CMS. Therefore, to create new Content Types, we need to declare a new JSON object for each of our Content Types in the `content-types.json` file. However, we still need to discover which props these objects expect. So let's get back to our previous example.\n\nCode input\n\nOutcome in the Headless CMS\n\ncopy\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"id\": \"landingPage\", \n\n4\n\n \"name\": \"Landing Page\", \n\n5\n\n \"configurationSchemaSets\": [ \n\n6\n\n { \n\n7\n\n \"name\": \"Settings\", \n\n8\n\n \"configurations\": [ \n\n9\n\n { \n\n10\n\n \"name\": \"seo\", \n\n11\n\n \"schema\": { \n\n12\n\n \"title\": \"Settings\", \n\n13\n\n \"description\": \"Search Engine Optimization options\", \n\n14\n\n \"type\": \"object\", \n\n15\n\n \"widget\": { \n\n16\n\n \"ui:ObjectFieldTemplate\": \"GoogleSeoPreview\" \n\n17\n\n }, \n\n18\n\n \"required\": [ \n\n19\n\n \"slug\", \n\n20\n\n \"title\", \n\n21\n\n \"description\" \n\n22\n\n ], \n\n23\n\n \"properties\": { \n\n24\n\n \"slug\": { \n\n25\n\n \"title\": \"Path\", \n\n26\n\n \"type\": \"string\", \n\n27\n\n \"default\": \"/\" \n\n28\n\n }, \n\n29\n\n \"title\": { \n\n30\n\n \"title\": \"Default page title\", \n\n31\n\n \"description\": \"Display this title when no other title is available\", \n\n32\n\n \"type\": \"string\", \n\n33\n\n \"default\": \"FastStore Starter\" \n\n34\n\n }, \n\n35\n\n \"description\": { \n\n36\n\n \"title\": \"Meta tag description\", \n\n37\n\n \"type\": \"string\", \n\n38\n\n \"default\": \"A beautifully designed store\" \n\n39\n\n }, \n\n40\n\n \"canonical\": { \n\n41\n\n \"title\": \"Canonical url for the page\", \n\n42\n\n \"type\": \"string\" \n\n43\n\n } \n\n44\n\n } \n\n45\n\n } \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\nNotice that, to declare a new Content Type, you must specify at least the following three parameters:\n\n| Key | Description |\n| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | The identification key of a Content Type, written in Camel Case. |\n| name | The name presented at the Headless CMS app. |\n| **(optional)** configurationSchemaSets | Creates a new tab on the page of that Content Type with advanced settings. In our example, the **Landing Page** includes a new tab called **Settings** with custom SEO settings. Check the [following section](#the-configurationschemasets-property) for more information. |\n\n### The `configurationSchemaSets` property\n\nBack to our example, notice that the **Landing Page** Content Type has the `configurationSchemaSets` definition. The `configurationSchemaSets` prop creates a new tab at the Headless CMS for that Content Type with advanced settings.\n\nFor the **Landing Page**, a custom section named **Settings**, which allows editors to change the site metadata, was created.\n\n\n\nAlso, notice that the `configurationSchemaSets` object must contain a `name`, written in **camel case**, and `configurations`. In its turn, the `configurations` object must include a `name` for identification, written in camel case, and a `schema`, written in [JSON Schema v6](https://read.calvincode.net/reader?url=http://json-schema.org/) \\- a description language for creating forms. The `schema` defines the structure of the form used by editors to submit data.\n\n> For more information on how to write a `schema`, check the [JSON Schema Reference](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema).\n\nAfter editing the `cms/content-types.json` file, remember to save your changes and check them live:\n\n1. Access the VTEX Admin and go to **Storefront > Headless CMS**.\n2. Click on **Create New** and check the available Content Type options.\n3. Click on **Landing Page** to create a new page and check the Settings tab.\n\n## Step 3: Adding Sections to the Headless CMS\n\nNow, let's make some of our frontend components available for editing at the Headless CMS by writing the content schemas that represent them.\n\nThese components are referred to as **Sections**, and to create them, you can follow the instructions provided in the guide [Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section). The guide offers detailed information on the process of creating Sections and integrating them into the Headless CMS for easy editing and management.\n\n### The `schema` property\n\nThe `schema` will always be unique for each of your Sections as they create the form that editors will use to submit data and change the content of a given React component.\n\nNotice that you must always declare the following properties inside the `schema` object:\n\n| Key | Description |\n| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| title | The name that identifies your component in the Headless CMS app. |\n| description | A brief description that helps editors understand the behavior of your component. |\n| type | The data type of your schema. Possible values are [string](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema/reference/string.html), [object](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema/reference/object.html), [array](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema/reference/array.html), [number](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema/reference/numeric.html%23number), [integer](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema/reference/string.html), [boolean](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema/reference/boolean.html). |\n\nDepending on the `type` of your schema, you may need to define particular fields related to your component structure. For example, for a schema of the `object` type, you'll need to determine `properties` that map key-value pairs. For a schema of the `array` type, you'll need to define the `items` of that array.\n\n> For more information on each property of a `schema`, check the [JSON Schema Reference](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema).\n\n### Using widgets\n\nWhen defining your Section `schema`, you can also use the [uiSchema](https://read.calvincode.net/reader?url=https://react-jsonschema-form.readthedocs.io/en/docs/api-reference/uiSchema/) along with [widgets](https://read.calvincode.net/reader?url=https://react-jsonschema-form.readthedocs.io/en/docs/usage/widgets/) to specify which UI widget should be used to render a given field of your schema. Common widgets are `draftjs-rich-text`, `image-uploader`, and `block-select`. Refer to the [Widgets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets) guide for more information.\n\n## Next step\n\nOnce you're satisfied with your Content Types and Sections, promote them to production: [Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-4-promoting-your-changes)\n\n## Related resources\n\n* [JSON Schema Reference](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema)\n* [react-jsonschema-form Playground](https://read.calvincode.net/reader?url=https://rjsf-team.github.io/react-jsonschema-form/)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/structuring-content-types-and-sections.mdx)\n\n[Setting up the Headless CMS« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-setting-up-the-headless-cms)[Promoting your changesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23what-youll-accomplish)\n\n[Step 1: Automatically syncing your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23step-1-automatically-syncing-your-changes)\n\n[Step 2: Adding Content Types to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23step-2-adding-content-types-to-the-headless-cms)\n\n[The configurationSchemaSets property](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23the-configurationschemasets-property)\n\n[Step 3: Adding Sections to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23step-3-adding-sections-to-the-headless-cms)\n\n[The schema property](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23the-schema-property)[Using widgets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23using-widgets)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23next-step)\n\n[Related resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23related-resources)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/structuring-content-types-and-sections.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23what-youll-accomplish)\n\n[Step 1: Automatically syncing your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23step-1-automatically-syncing-your-changes)\n\n[Step 2: Adding Content Types to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23step-2-adding-content-types-to-the-headless-cms)\n\n[The configurationSchemaSets property](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23the-configurationschemasets-property)\n\n[Step 3: Adding Sections to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23step-3-adding-sections-to-the-headless-cms)\n\n[The schema property](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23the-schema-property)[Using widgets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23using-widgets)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23next-step)\n\n[Related resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-structuring-content-types-and-sections/docs/guides/faststore/getting-started-structuring-content-types-and-sections%23related-resources)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0ba3d2da
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference giftcard 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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-api/docs/api-reference/giftcard-api/)\n\nGift cards\n\nTransactions\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-api/docs/api-reference/giftcard-api/)\n\nGift cards\n\nTransactions\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-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/giftcard-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PaUpdate delivery promises for an external seller’s item« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api/docs/api-reference/delivery-promise-notification-api%23patch-/delivery-promises/external-sellers/-sellerId-/items/-itemId-)[PoCreate GiftCardNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api/docs/api-reference/giftcard-api%23post-/giftcards)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_578dca57
|
[
{
"role": "system",
"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 filling the application form for development 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-filling-the-application-form-for-development/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-filling-the-application-form-for-development/docs/api-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-filling-the-application-form-for-development/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-filling-the-application-form-for-development/docs/storefront-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-filling-the-application-form-for-development/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-filling-the-application-form-for-development/docs/troubleshooting)\n\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-filling-the-application-form-for-development/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/updates/release-notes)\n\nFilling the Application form for development\n\nThe VTEX IO platform currently works as a **closed beta solution**, only accessible for a small group of developers, for the following development projects:\n\n* **Custom Admin Apps**\n* **Custom backend Apps**\n* **Custom Pixel apps**\n* **Custom mobile Apps**\n\n> Every VTEX account and partner can freely use the VTEX IO to develop custom storefront components, meaning that the platform works as an open beta solution when it comes to React projects. The Application form is therefore not needed for this scenario.\n\nTo become part of this group, you need to first fill in the [**Application form**](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfhuhFxvezMhPEoFlN9yFEkUifGQlGP4HmJQgx6GP32WZchBw/viewform) which is used by our product team to properly peruse your development project and grant you all the necessary permissions after your project has been approved.\n\nDuring this process, you may feel uncertain as to which permission best suits your scenario, or about what to name the new app or even about how much detail to provide on the project when filling in the form.\n\nTo help answer some of these questions, we've put together **guidelines regarding the VTEX IO Application form** which will make it easier for you to start developing on the platform.\n\n## Guidelines\n\n### Apps development by functionality\n\nFaced with a more complex project, that involves storefront components and a backend service, for example, developers tens to request permissions to develop multiple apps aimed at each of these well defined platform functions.\n\nThe problem with this code segmentation is that it's done from a developer's point of view, someone who unlike the end user, has technical know-how about the platform. For end users, microservices done behind the scenes on the platform are not what matter.\n\nTherefore, the existence of several small apps that when put together solve a single problem can become frustrating from a user's perspective - and with good reason.\n\n**It's crucial for users to be able to solve any problem in the most practical way possible**, using the solution given by a single app. This includes a **seamless installation process**.\n\n> Be careful however: overly generic apps, which bundle up a lot of distinct functionalities, are also not recommended mainly because the code can become complex and heavy.\n\nThe most important practice is to **understand which service your app is meant to offer end users** and, based on that, decide how your development is going to be. Make sure that each functionality is correctly working towards delivering the desired result.\n\n### App naming\n\nThe app name filled in our Application form must be permanent. In other words, this means that you should be careful when choosing it once the name filled in also must be the one used in the app's `manifest.json` file.\n\nOn the VTEX IO platform, apps' names are _[kebab cased](https://read.calvincode.net/reader?url=https://en.wiktionary.org/wiki/kebab%5Fcase)_. Basically, they must be comprised of lowercase letters separated by hyphens. Special characters, such as `*` and `@`, and numbers in the beginning of the name are not recommended.\n\nWhen choosing the app name, remember: it should **concisely express the app's purpose.**\n\nTo put this into practice, let's imagine that an app is developed for a native integration with Instagram. You should not name it `integration` or `social-media`, for example. Instead, the best choices for this scenario would be `instagram-integration` or simply `instagram`.\n\n### App versioning\n\nThe VTEX IO Platform uses the [**Semantic Versioning specification**](https://read.calvincode.net/reader?url=https://semver.org/) for versioning all apps developed on it.\n\nIt means that if you're requesting to develop an app from scratch, you should always start with major `0`.\n\n### Apps' vendor\n\nThe app's vendor is the **app's owner**, the VTEX account that is developing the application.\n\nIf the app is to-be sold on VTEX App Store, the `vendor` is the one to profit from its installations. Therefore, remember the following: even is the app is installed on multiple accounts, you don't need to change the app's vendor value for every one of them. **An app must have only one vendor, which is responsible for its development and maintenance**.\n\n### Project's motivation\n\nYour development project should be **as descriptive as possible!** This means that you should provide as many details as possible, such as the project's need, objective and impact.\n\n#### Dont's\n\n* \"_It's a marketplace integration._\"\n\n#### Do's\n\n* \"_This app will integrate a VTEX Storefront with Instagram API, allowing merchants to display their latests Instagram posts and stories. It will also allow style customization via Admin. We also need a backend service because of the external service's API quotas, since an API key is necessary for high usage._\"\n\nIf you have any question about these guidelines or about the Application form, feel free to contact our team on [Store Discussion](https://read.calvincode.net/reader?url=http://github.com/vtex-apps/store-discussion/)!\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-filling-the-application-form-for-development.md)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23guidelines)\n\n[Apps development by functionality](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23apps-development-by-functionality)[App naming](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23app-naming)[App versioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23app-versioning)[Apps' vendor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23apps-vendor)[Project's motivation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23projects-motivation)\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-filling-the-application-form-for-development.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23guidelines)\n\n[Apps development by functionality](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23apps-development-by-functionality)[App naming](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23app-naming)[App versioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23app-versioning)[Apps' vendor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23apps-vendor)[Project's motivation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/docs/guides/vtex-io-documentation-filling-the-application-form-for-development%23projects-motivation)\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_0978b709
|
[
{
"role": "system",
"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 10 making your app publicly available 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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/docs/api-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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/docs/storefront-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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/docs/troubleshooting)\n\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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/create-master-data-crud-app)\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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/create-master-data-crud-app)\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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/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-10-making-your-app-publicly-available/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n9\\. Making your app publicly available\n\nOnce you have completed all the previous steps and are comfortable with the setup, it is time to learn how to make your app publicly available, **allowing other users to use your app too**.\n\nBefore continuing with the app development flow, it is important first to define how you will be distributing your app–who will be able to install your app? Will you charge for using it? If so, what will be the cost for interested accounts?\n\nThe answers to these questions vary depending on the distribution type chosen for the app. The VTEX IO platform supports the following app types:\n\n* **Private** \\- Can only be installed by the `vendor` account, the account that develops and maintains it.\n* **Public** \\- It is available for all accounts in the VTEX platform ecosystem; a fee may be charged for its use or not.\n\n## Defining distribution\n\nThe choice between private or public has to be made before the app is launched.\n\nThe reason is that depending on the chosen type, some settings have to be configured in the app's `manifest.json` file before it is distributed. After all, the settings in the `manifest` define who will be able to use the component and whether it will be free or not.\n\nTo learn how to configure your app's `manifest.json` file properly, access the documentation about [Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/) and follow the instructions that fit the desired scenario for your project.\n\nAfter following those detailed steps, your app will be ready to be correctly distributed!\n\nRemember that [_linking_](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) the app you are working on will not be enough: you will also need to launch, publish, and install it in a production workspace for testing and, finally, validate it for _deploy_, as we will see below.\n\n## Launching a new version\n\nIf you are sure about all the changes made in the development workspace, it is time to launch a new version of your app.\n\nUsing your terminal, access the app folder and run the following command:\n\n`1\n\nvtex release major \n\n`\n\nThis will:\n\n* Update the versioning in the `CHANGELOG.md` and `manifest.json` files following [expected semantics](https://read.calvincode.net/reader?url=https://semver.org/).\n* Create a _launch_ commit.\n* Create a GitHub repository for the app.\n\nIf you want to release a **Beta** version, run the command `vtex release major beta` on your terminal. It will execute the same actions as the previous command, except that you will be launching a _beta_ version for your app instead of a _stable_ version.\n\n> Do not forget to log in to the desired VTEX account before launching the new version so that the app's `vendor` is the account where you have been working.\n\n## Publishing on the VTEX IO platform\n\nOnce the app has been launched, it has to be properly installed to have the settings you tested. However, it is not possible to simply install an existing app on your local desktop.\n\n> Note that when launching your app in step 2 above, you did not link it to the VTEX IO platform. The previous command only automated actions for proper versioning.\n\nThat means now you have to publish the app on the platform! Using your terminal, access the app folder and run the following command:\n\n`1\n\nvtex publish \n\n`\n\nThe command will transform your app into a _**release candidate version**_, making it available to be installed for testing with VTEX IO CLI.\n\n> You have to always be logged in to the desired VTEX account for publishing the app. Make sure the app's `vendor` is the same as the account you are working on.\n\nIf your app does not have the `billingOptions` field configured, users with access to the VTEX account that published it will also be able to install the app through the Admin via the **Apps** section.\n\n## Installing in a production workspace\n\nHaving your app ready to be installed, you need to create a production workspace to test the settings and possible behaviors.\n\nUsing your terminal, run the following command (replacing the curly brackets with the desired name for your new workspace):\n\n`1\n\nvtex use {WorkspaceName} --production \n\n`\n\n> From this point forward, further changes are not recommended. This is because a production workspace is able to receive user traffic and can be accessed by people other than you. If you want to make any changes to the code, you have to work on the new settings in a development workspace and then follow the steps in this article again.\n\nTo install the app in the new workspace, run the command below, replacing the curly brackets with your scenario's real values:\n\n`1\n\nvtex install {appVendor}.{apNname}@{appVersion} \n\n`\n\n## Validating the deploy\n\nIt is time to validate your _release candidate version_!\n\nWe recommend that you first run a [native A/B test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing) between the new production workspace and your store's Master workspace to test the stability of the app.\n\n> If you are working with a beta version and all your settings have already been properly tested, we recommend that you return to the second step of this article to launch the app's non-beta version and then follow the walkthrough again.\n\nOnce you are satisfied with the results, access the app's folder on your terminal and run the following command to publish your _release candidate version_ as a _stable_ version:\n\n`1\n\nvtex deploy \n\n`\n\nRunning the command will cause the new _stable_ version of the app to be automatically installed on all accounts that had previously installed the _release candidate_ version.\n\n## Extra steps\n\n### Promoting your workspace to Master\n\nPromoting the production workspace where the app was installed to Master is essential to be able to render it to your store's end users, the ones who will actually interact with the developed component.\n\nThat means if you want to use the app that was developed in the store you are working on, you need to complete one more step in your development process.\n\nUsing your terminal, log in to your VTEX account and make sure you are using the production workspace used in the previous steps. Then, run the command below:\n\n`1\n\nvtex workspace promote \n\n`\n\nThe status of a Master workspace is `production true`. Upon receiving this response from your terminal, your app will already be available to your store's users.\n\n### Submitting your app to the VTEX App Store\n\nWhether you incorporate the new component into your VTEX Store Theme or not, you may still want to add the app you developed to the VTEX App Store app catalog.\n\nThe [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/) is a _marketplace_ for _plug&play_ solutions and can be used by any interested VTEX account that wants to make available its solutions to other accounts in the ecosystem.\n\nTo make your app available, check the documentation for [Submitting an app in the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/).\n\n---\n\n**All set!** After completing these steps, the app will be launched, published, tested, validated, and, finally, made public for all its users.\n\nDuring this article series, you learned all the necessary steps to develop a frontend app from scratch using React, GraphQL, CSS, and the VTEX IO development platform.\n\nTo understand more about the platform's development possibilities, do not forget to access the rest of our [documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides)!\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-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-10-making-your-app-publicly-available.md)\n\n[8\\. Improving performance with caching« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available//docs/guides/vtex-io-documentation-9-improving-performance-with-caching)[Best practicesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available//docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Defining distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23defining-distribution)\n\n[Launching a new version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23launching-a-new-version)\n\n[Publishing on the VTEX IO platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23publishing-on-the-vtex-io-platform)\n\n[Installing in a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23installing-in-a-production-workspace)\n\n[Validating the deploy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23validating-the-deploy)\n\n[Extra steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23extra-steps)\n\n[Promoting your workspace to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23promoting-your-workspace-to-master)[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23submitting-your-app-to-the-vtex-app-store)\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-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-10-making-your-app-publicly-available.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Defining distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23defining-distribution)\n\n[Launching a new version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23launching-a-new-version)\n\n[Publishing on the VTEX IO platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23publishing-on-the-vtex-io-platform)\n\n[Installing in a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23installing-in-a-production-workspace)\n\n[Validating the deploy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23validating-the-deploy)\n\n[Extra steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23extra-steps)\n\n[Promoting your workspace to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23promoting-your-workspace-to-master)[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23submitting-your-app-to-the-vtex-app-store)\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_7887206b
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides master data 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/master-data-components/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-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/master-data-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/master-data-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/master-data-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/master-data-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/master-data-components/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/understanding-master-data)\n\n[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components)\n\n[Master Data infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-infrastructure)\n\n[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-api)\n\n[Data consistency and synchronization in Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/data-consistency-and-synchronization-in-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/understanding-master-data)\n\n[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components)\n\n[Master Data infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-infrastructure)\n\n[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-api)\n\n[Data consistency and synchronization in Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/data-consistency-and-synchronization-in-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/understanding-master-data)\n\n[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components)\n\nMaster Data components\n\nLearn about Data Entities, Documents, Fields, and Indexes in Master Data, and how these components work together to structure and optimize data for efficient querying.\n\nThis guide introduces the key components of Master Data and their functionalities. These components are conceptually similar to those in traditional database systems, but with distinct terminology:\n\n* **Data Entity**: Represents a table-like structure that contains multiple Documents.\n* **Document**: Represents a record (row) within a Data Entity.\n* **Field**: Represents an attribute (column) of a Document.\n* **Index**: Represents an optimization layer linked to a specific field to speed up searches.\n\n\n\n## Data Entity\n\nA Data Entity is analogous to a table in traditional databases. It stores records (or [Documents](#document)) and [Fields](#field), representing the structure of data in Master Data.\n\nMaster Data has two versions (V1 and V2):\n\n* **V1:** Data Entities are identified by a two-letter uppercase acronym (e.g., `NT`). \n * Example: `CL` stores customer-related data like name, email, and document; `AD` stores customer address data, such as street, city, and recipient name.\n* **V2:** Data Entities are identified by their full name (e.g., `Notification`).\n\n> This module may process personal or sensitive information. Learn more about how VTEX handles data privacy in our [Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-privacy) guide.\n\n### Document\n\nA Document represents a record (or row) within a Data Entity. Each Document has a unique identifier (the `id` Field).\n\nFor example, in the `CL` Data Entity, each customer is represented by a Document that includes fields like `id`, `name`, `email`, and other personal details.\n\n### Field\n\nA Field is a specific attribute or characteristic of a Document within a Data Entity, analogous to columns in a database table. Each Field has a defined data type:\n\n* `string`: Text-based data (e.g., `name`).\n* `number`: Numeric data (e.g., `age`).\n* `date`: Date-based data (e.g., `birthdate`)\n* `object`: A structured data type with key-value pairs.\n* `array`: A list of values.\n* `null`: Explicitly undefined value.\n\nFor example, in the `CL` Data Entity, Fields may include `name`, `email`, `birthdate`, and `document_number`. Each Field has a type that determines its data format:\n\nConsistent structure is enforced across all Documents in a Data Entity based on its defined Fields.\n\n## Index\n\nAn Index enables you to search for Documents based on a Field, without needing the Document's `id`. You can create an Index for any Field in a Data Entity.\n\nFor example, if the `CL` Data Entity has an Index on the `email` Field, you can retrieve a Document by querying the `email` value instead of the `id`.\n\nIndexes are configured differently depending on the Master Data version:\n\n* **V1:** Managed via the Admin interface. For more information, refer to [Indexes in Master Data V1](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-an-index-on-master-data--tutorials%5F785). Once an Index is set up, you can retrieve Documents using the [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search) endpoint with the Field name as the query parameter and the value of Field as the value of the parameter. Example: `/dataentities/CL/search?email=my@email.com`.\n* **V2:** Managed via API. Refer to [PUT - Create index](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/indices) for more information. Once an Index is set up, you can retrieve Documents using the [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/search) endpoint.\n\nWhen using an `id`, the Index retrieves a single Document at a time, but using an indexed Field allows you to search for Documents based on that Field's value instead.\n\n> Indexes are created when a Document is created or modified. Documents will only have an Index if the Data Entity's Index was set up before or during the Document's creation or modification. Documents created before the Index was set up must be updated to receive it.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/understanding-master-data/master-data-components.md)\n\n[Understanding Master Data« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components//docs/guides/understanding-master-data)[Master Data infrastructureNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components//docs/guides/master-data-infrastructure)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Data Entity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components%23data-entity)\n\n[Document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components%23document)[Field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components%23field)\n\n[Index](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components%23index)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/understanding-master-data/master-data-components.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Data Entity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components%23data-entity)\n\n[Document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components%23document)[Field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components%23field)\n\n[Index](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components/docs/guides/master-data-components%23index)\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_cc36d797
|
[
{
"role": "system",
"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 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/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/docs/api-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/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/docs/storefront-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/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/docs/troubleshooting)\n\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/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/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/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/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/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/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/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/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/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/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/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/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/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/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/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/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/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/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/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/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/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/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/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/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/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/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/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/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/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/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/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/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/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/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/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/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/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/docs/vtex-io-apps)\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-suite)\n\nB2B Quotes & Carts\n\nOfficial extension\n\nVersion: 3.0.3\n\nLatest version: 3.0.3\n\n[](#contributors-)\n\n> The **B2B Quotes & Carts** app is part of VTEX’s [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-suite) solution: a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships. We recommend that you use it alongside the other apps in this suite for all functionalities to work as expected.\n\nThe B2B shopping experience frequently requires the possibility for customers to request quotes and negotiate prices with sales representatives.\n\nThe **B2B Quotes & Carts** app allows customers who are part of [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations) to request a quote for a shopping cart and save it for future use – including its items, product quantities and prices. This enables price negotiations between them and the store’s sales representatives, as well as order approval flows within their organization.\n\n## Before you start\n\nFirst, make sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-install) installed in your machine.\n\nNote that installing **B2B Quotes & Carts** will also result in [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions) being installed as a dependency app – it allows you to grant specific storefront roles for B2B users in an organization. This is especially useful for organizations with multiple users who have different responsibilities, such as placing orders, approving orders or managing the organization users. See the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions) app documentation for information on the available roles and how to customize their permissions (optional).\n\nIf you want to be able to manage roles and permissions on the VTEX Admin, you must install [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions-ui) as well.\n\nAlong with this app, we recommend installing [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-checkout-settings), which includes quotes-related functionalities to checkout. For example, it allows you to add a `Create a Quote` button to the checkout’s shopping cart page, as well as “lock” the checkout if a quote is in use, preventing the cart contents from being changed until the order is placed.\n\n## Installation\n\nYou can install the **B2B Quotes & Carts** app by running `vtex install vtex.b2b-quotes` in your terminal, using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\nWhen you install the **B2B Quotes & Carts** app, a data entity named **quotes** is created in **Master Data V2**. This entity stores all the information related to quotes and saved carts generated through the app.\n\n## How the app works\n\nThe **B2B Quotes & Carts** app enables a shared [My Quotes](#my-quotes) page for members of a B2B organization, from where it is possible to create a quote or saved cart and view existing quotes and saved carts.\n\nIt is also possible to manage each quote or saved cart’s [details](#quote-details), including the possibility to edit them, request adjustments, approve or decline them or use them to place an order.\n\nIn addition, the app enables a set of [email templates](#email-templates) to notify members of the organization of quote status changes through Message Center.\n\nThe ability to use these resources depends on having the required [storefront permissions](#storefront-permissions), as explained in the next section.\n\n| **Permission** | **Default roles** |\n| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| **Create Quotes and Carts** | Store AdminSales AdminSales ManagerSales RepresentativeOrganization AdminOrganization ApproverOrganization Buyer |\n| **Access My Cost Center's Quotes and Carts** | Sales RepresentativeOrganization ApproverOrganization Buyer |\n| **Access My Organization's Quotes and Carts** | Sales ManagerOrganization Admin |\n| **Access All Quotes and Carts** | Store AdminSales Admin |\n| **Place Orders from Quotes and Carts** | Store AdminSales AdminSales ManagerSales RepresentativeOrganization AdminOrganization Approver |\n| **Decline Quotes and Carts** | Store AdminSales AdminSales ManagerSales RepresentativeOrganization AdminOrganization Approver |\n| **Edit My Cost Center's Quotes and Carts** | Sales Representative |\n| **Edit My Organization's Quotes and Carts** | Sales Manager |\n| **Edit All Quotes and Carts** | Store AdminSales Admin |\n\nIf you want to be able to manage roles and permissions for **B2B Quotes & Carts** on the VTEX Admin, you must install [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions-ui) and refer to its documentation.\n\n### My Quotes\n\nThe **B2B Quotes & Carts** app enables the **My Quotes** page, an interface to manage quotes and saved carts in the storefront, provided that the user is logged in and has the required storefront permissions.\n\nTo access **My Quotes**, customers or sales users must follow the instructions below.\n\n1. Access the storefront and log in.\n2. Click `Hello, {name}`.\n3. Click on **My Account**.\n4. Go to **Quotes and Saved Carts** on the sidebar. You will see the page below.\n\n\n\n> Quotes and saved carts are shown together in the same table. The differences are the following: \\_ Only quotes can have a status of **Pending** or **Revised**. \\_ Sales users are not notified when saved carts are created. \\* It is possible to edit a saved cart such that it becomes a quote, as explained in [Quote Details](#quote-details).\n\nIn this page, it is possible to use the following resources:\n\n* **Search bar**: allows you to look up specific quotes or saved carts by name.\n* **Filters**: allows you to filter the displayed quotes or saved carts by _Status_, _Organization \\_or \\_Cost Center._ The two last options are available under `More`.\n* **New quote**: allows you to create a quote or saved cart by clicking on the `New Quote` button. See more details on this in the [Creating a quote or saved cart](#creating-a-quote-or-saved-cart) section.\n\nThe list of quotes and saved carts displays the following information:\n\n* **Ref. Name:** the quote or saved cart’s reference name.\n* **Subtotal:** subtotal of the shopping cart associated with the quote or saved cart.\n* **Created by:** email of the user who created the quote or saved cart.\n* **Created on:** date when the quote or saved cart was created, in the MM/DD/YYYY format.\n* **Expiration:** date when the quote or saved cart will expire, in the MM/DD/YYYY format.\n* **Status:** current state of the quote or saved cart, including the following options: \n * **Ready**: the quote or saved cart is ready to be used to place an order. \n * **Pending**: the quote is waiting for review and adjustment by a sales user. \n * **Revised**: the quote is waiting for additional review and adjustment by a sales user. \n * **Declined**: the quote or saved cart has been declined and cannot be used to place an order. \n * **Expired**: the quote or saved cart has reached its expiration date and cannot be used to place an order. \n * **Placed**: the quote or saved cart has been used to place an order and cannot be used again.\n* **Last Update:** date when the quote or saved cart was updated for the last time, in the MM/DD/YYYY format.\n* **Organization:** name of the organization the quote or saved cart is associated with.\n* **Cost Center:** name of the cost center the quote or saved cart is associated with.\n\nFrom the list, users may click on any row or click on  **\\> Details** to view and edit the [details](#quote-details) of that quote or saved cart, according to what their permissions allow.\n\nDepending on the current user’s [storefront permissions](#storefront-permissions), the **My Quotes** page will show a list of quotes and saved carts containing one of the following:\n\n| **Permission** | **Content** |\n| --------------------------------------------- | ------------------------------------------------------------------------------- |\n| **Access My Cost Center's Quotes and Carts** | All quotes and saved carts created by users in the current user’s cost center. |\n| **Access My Organization's Quotes and Carts** | All quotes and saved carts created by users in the current user’s organization. |\n| **Access All Quotes and Carts** | All quotes and saved carts in the current store, regardless of organization. |\n\n### Creating a quote or saved cart\n\nIn order to create a quote or saved cart, it is necessary to have the **Create Quotes and Carts** [permission](#storefront-permissions). After adding products to the cart in the storefront, users with these permissions can use the contents of their cart to create a saved cart or to request a quote. They should follow the instructions below.\n\n1. Fill in the shopping cart with the desired products.\n2. Take one of the following actions to create a quote or saved cart: \n * Clicking the `Create a Quote` button during checkout, provided that **B2B Checkout Settings** is installed and this button is enabled in the app’s [configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-checkout-settings%23configuration). \n * Navigating to the `/b2b-quotes/create` route. \n * Clicking the `+ New` button on the **My Quotes** page. \n Any of these paths will lead to the **Create Quote** page, illustrated below.\n3. Fill in the quote or saved cart’s **Name**.\n4. Make sure that all the information in the **Create Quote** page is correct: \n * **Original Subtotal:** subtotal of the shopping cart before any discounts. \n * **Percentage Discount:** percentage of the discount offered by a sales representative. \n * **Quoted Subtotal:** subtotal of the quote, including any discounts offered by sales representatives. \n * **Image:** image of the selected product. \n * **Ref. Code:** reference code of the selected product. \n * **Name:** name of the product. \n * **Original Price:** original price of the product. \n * **Quoted Price:** price of the product including any discounts offered by sales representatives. \n * **Quantity:** quantity of items. \n * **Total:** total value considering the quoted price and the quantity of items.\n5. Write a note in the optional **Add Note** field, if necessary. \nNotes added here will be visible as part of the quote or saved cart’s [Update History](#quote-details) and can be seen by salespeople or other members of your organization and cost center. For example, if a user wishes to request a specific discount from the B2B store’s salesperson, they may include this request as a note.\n6. Click on one of the following options: \n * `Save for later`: clicking on this button will result in the creation of a saved cart. The status of the newly created saved cart will be set as **Ready**, meaning that it can immediately be used to place an order by any user within that organization or cost center who has the **Place Orders from Quotes and Carts** [permission](#storefront-permissions). \n * `Request quote`: clicking on this button will result in the creation of a quote. The status of the newly created quote will be set as **Pending**, meaning that it will need to be reviewed and adjusted by a salesperson before any special discounts can be applied. \n Note that a **Pending** quote can still be used to place an order, as it is essentially a saved cart at this point, with the original item quantities and prices from the user’s shopping cart.\n\nThe items in the table, along with the quantities and prices shown, will be saved when the quote or saved cart is created.\n\n\n\n### Quote Details\n\nThe **Quote Details** page displays all the information about a specific quote or saved cart, as well as the available actions, depending on its status and the user’s [storefront permissions](#storefront-permissions).\n\nUsers can access this page through the storefront by going to **My Account > Quotes and Saved Carts**.\n\n\n\nThis page displays the following information about a specific quote:\n\n* **Name:** reference name of the quote or saved cart.\n* **Original Subtotal:** subtotal of the shopping cart before any discounts.\n* **Percentage Discount:** percentage of the discount offered by a sales representative.\n* **Quoted Subtotal:** subtotal of the quote, including any discounts offered by sales representatives.\n* **Expiration:** date when the quote or saved cart will expire, in the MM/DD/YYYY format.\n* **Status:** current state of the quote or saved cart, as in [My Quotes](#my-quotes).\n* **Image:** image of the selected product.\n* **Ref. Code:** reference code of the selected product.\n* **Name:** name of the product.\n* **Original Price:** original price of the product.\n* **Quoted Price:** price of the product including any discounts offered by sales representatives.\n* **Quantity:** quantity of items.\n* **Total:** total value considering the quoted price and the quantity of items.\n* **Update History:** includes a history of all events related to the quote, such as its creation and discounts offered, including notes if there are any.\n* **Add Note:** optional field to write comments or notes. Notes added here will be visible as part of the quote or saved cart’s [Update History](#update-history). For example, if a user wishes to request a specific discount from their salesperson, they may include this request as a note.\n\nThe following actions are available, depending on the user’s storefront permissions:\n\n| Actions | Required storefront permissions |\n| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| [Editing a quote](#editing-a-quote) | Any of the following:Edit My Cost Center's Quotes and CartsEdit My Organization's Quotes and CartsEdit All Quotes and Carts |\n| [Requesting additional adjustments to a quote](#requesting-additional-adjustments-to-a-quote) | Any of the following:Access My Cost Center's Quotes and CartsAccess My Organization's Quotes and CartsAccess All Quotes and Carts |\n| [Declining a quote or saved cart](#declining-a-quote-or-saved-cart) | Decline Quotes and Carts |\n| [Using a quote or saved cart to place an order](#using-a-quote-or-saved-cart-to-place-an-order) | Place Orders from Quotes and Carts |\n\n#### Editing a quote\n\nUsers with **Edit** [permissions](#storefront-permissions) – who are typically users associated with any of the Sales roles or the Store Admin role – can edit quotes in the **Quote Details** page as follows:\n\n* Change the price or quantity of each SKU by editing them directly in the **Quoted Price** and **Quantity** columns of the product list within the quote.\n* **Apply Percentage Discount:** apply a percentage discount to the entire quote by dragging the discount bar up to the desired percentage. This will override any changes made to individual product prices.\n* **Expiration Date Change:** change the quote’s expiration date.\n* **Add Note:** write an optional comment.\n\nAfter making any of the above edits on the quote details page, the user must save the quote by clicking `Save quote`.\n\nThis will have the effect of setting the quote’s status to **Ready** and notifying any user who has previously interacted with the quote of the change via email – check [Email templates](#email-templates) for more details on this notification.\n\n\n\n> To take discounts into consideration, the **B2B Quotes and Carts** app is integrated with the [Order Authorization](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-order-authorization-works--3MBK6CmKHAuUjMBieDU0pn) system. If there is a manual discount rule that will automatically deny a discount above a certain percent, **B2B Quotes and Carts** will not allow a discount above this amount to be applied.\n\n#### Requesting additional adjustments to a quote\n\nUsers who lack any of the **Edit** permissions but have any of the **Access** [permissions](#storefront-permissions) can add additional notes to a quote or saved cart if its current status is **Ready**, **Pending**, or **Revised**.\n\nIf a quote is **Ready**, meaning that it has been adjusted and saved by a sales user, its status will change to **Revised** when an organization user adds notes and clicks `Submit to Sales Rep`. This is intended as a way for the organization user to request additional adjustments to pricing or quantity. All users who have previously interacted with the quote will receive a notification including the contents of the notes field – check [Email templates](#email-templates) for more details on this notification.\n\n#### Declining a quote or saved cart\n\nA declined quote or saved cart can no longer be edited or used to place an order. Users with the **Decline Quotes and Carts** [permission](#storefront-permissions) may decline a quote or saved cart if its current status is **Ready**, **Pending** or **Revised**. This can be done by clicking the `Decline` button on the quote details page.\n\nAll users who have previously interacted with the quote will be notified that it has been declined – check [Email templates](#email-templates) for more details on this notification.\n\n#### Using a quote or saved cart to place an order\n\nUsers with the **Place Orders from Quotes and Carts** [permission](#storefront-permissions) may use a quote or saved cart to place an order if its current status is **Ready**, **Pending**, or **Revised**.\n\nThey can do this by clicking the `Use Quote` button on the quote details page. The user will be redirected to checkout with the contents of the quote or saved cart added to their current cart. Anything that was previously in the user’s cart will be cleared.\n\nIf the [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-checkout-settings) app is installed, the checkout will be in a “locked” state until the order is placed, meaning that product quantities cannot be changed, and products cannot be added or removed. If there are not enough items in stock to meet the quantity specified in the quote or saved cart, the amount will be automatically adjusted. If a given product has no availability, checkout will allow it to be removed from the cart.\n\nOnce the order has been placed, the quote or saved cart’s status will automatically change to **Placed**, after which point it cannot be used again.\n\n### Email templates\n\nThe **B2B Quotes & Carts** app provides a set of three email templates to be sent to B2B users, triggered automatically based on specific changes:\n\n| **Template name** | **Recipients** | **Email trigger** |\n| ----------------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Quote created | Only users with the **sales-admin** role receive this email. | Sent only if all of the following conditions are met:• The quote creator does not have permission to edit quotes.• The quote must be created using the Request quote button and cannot be saved for later. |\n| Quote placed | All users who edited, requested adjustments or approved the quote. | Sent when an order is placed from the existing quote. |\n| Quote updated | All users who interacted with the quote. | Sent when the quote is updated in any way, including changes in discounts, updates to expiration dates, addition of new notes, or quote refusal. |\n\nIf you want to view or edit any of these templates, follow the steps below.\n\n1. In the VTEX Admin, go to **Customer > Message center > Templates**.\n2. In the search bar, type `quote`.\n3. Click on the template you want to view or edit.\n4. Make the desired changes in the template. You can learn more about editing **Message Center** templates by reading our documentation on [How to create and edit transactional email templates](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/335JZKUYgvYlGOJgvJYxRO).\n5. Click on `Save`.\n\n## **Configuration (optional)**\n\nTo change the app’s settings, access **Account Settings** \\> **B2B Quotes** in the VTEX Admin.\n\nOn this page, you can configure the following option:\n\n* **Default expiration period (in days) for quotes and saved carts:** this field allows you to configure the default expiration date for new quotes requested by customers in your store. The default value is 30 days. The minimum value you can set is 1, and there is no maximum value.\n\nMake sure you click on `Save Settings` after any changes.\n\nNote that users with [storefront permissions](#storefront-permissions) to edit quotes will be able to adjust the expiration dates of individual quotes as needed.\n\n\n\n[B2B Orders History« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-orders-history)[B2B Quotes GraphQL APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-quotes%23before-you-start)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-quotes%23installation)\n\n[How the app works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-quotes%23how-the-app-works)\n\n[My Quotes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-quotes%23my-quotes)[Creating a quote or saved cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-quotes%23creating-a-quote-or-saved-cart)[Quote Details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-quotes%23quote-details)[Email templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-quotes%23email-templates)\n\n[Configuration (optional)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes/docs/apps/vtex.b2b-quotes%23configuration-optional)\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_7d74629a
|
[
{
"role": "system",
"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 login 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/login-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/login-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/login-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/login-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/login-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/login-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/login-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-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/login-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-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/login-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide)\n\n[Admin (SAML 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide-admin-saml2)\n\n[Webstore (OAuth 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide-webstore-oauth2)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-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/login-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/login-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-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/login-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/login-integration-guide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-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/login-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-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/login-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide)\n\n[Admin (SAML 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide-admin-saml2)\n\n[Webstore (OAuth 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide-webstore-oauth2)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-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/login-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/login-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-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/login-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/login-integration-guide/docs/guides)\n\nIntegration Guides\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide)\n\nLogin (SSO)\n\nTo integrate an external identity provider in VTEX, you should first understand the basics of how our identity and access management services work. This article provides the main concepts and restrictions to get you started. After reading through it, you should move on to the [Webstore (OAuth2)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2) or [Admin (SAML 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2) articles for their implementation details.\n\n## Identity and Access Management (IAM)\n\n**VTEX ID** is the service used for identifying users on our platform. Web browsers and mobile apps interact with it to obtain an authentication token for a specific user. Receiving this token is what warrants that a user is \"logged in\", as it is used to communicate with services requiring authentication.\n\nAn **audience** is the context in which VTEX ID is used. It defines the business rules and the type of persona that will interact with the module. We currently have two scopes:\n\n* **Admin** for access to a VTEX admin panel\n* **Webstore** for access to a VTEX storefront\n\nUpon receiving an authentication token, applications can use it to verify if the user has a specific set of permissions by interacting with the service responsible for access management: **License Manager**.\n\nWe will not cover access management in this guide, but you can read more about roles in our [Help Center article](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/access-profiles--7HKK5Uau2H6wxE1rH5oRbc).\n\n> If you are already familiar with the [OAuth 2.0 specification](https://read.calvincode.net/reader?url=https://oauth.net/2/scope/), feel free to make this association if you find it helpful.\n\n### Admin\n\nThis is the audience used for dealing with users that need to access the administrative interface. Each component inside the admin panel requires different permissions, which are fully managed by the [Sponsor user](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-the-master-user--3oPr7YuIkEYqUGmEqIMSEy) of your VTEX account using [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/access-profiles--7HKK5Uau2H6wxE1rH5oRbc). The token generated by VTEX ID in this scope can be used for [authentication with most VTEX APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication).\n\n### Webstore\n\nThis is the audience used for ecommerce stores to identify customers throughout their shopping experience. Users in this scope can sign-in using credentials they already have, which may be shared between different stores or platforms you manage. The token generated by VTEX ID in this scope can be used to interact with the store checkout and storefront apps.\n\n## Comparison chart\n\n| Admin | Webstore | |\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |\n| Integration protocol | SAML 2.0 | OAuth 2.0 |\n| Cookie name | VtexIdclientAutCookie | VtexIdclientAutCookie\\_{accountName} VtexIdclientAutCookie\\_{accountId} |\n| Multi-factor authentication |  |  |\n| Idle timeout |  |  |\n| Google Login |  |  |\n| Facebook Login |  |  |\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/login-integration-guide.md)\n\n[Headless profile management and order history« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide//docs/guides/headless-profile-management-and-order-history)[Admin (SAML 2.0)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide//docs/guides/login-integration-guide-admin-saml2)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Identity and Access Management (IAM)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide%23identity-and-access-management-iam)\n\n[Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide%23admin)[Webstore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide%23webstore)\n\n[Comparison chart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide%23comparison-chart)\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/login-integration-guide.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Identity and Access Management (IAM)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide%23identity-and-access-management-iam)\n\n[Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide%23admin)[Webstore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide%23webstore)\n\n[Comparison chart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide/docs/guides/login-integration-guide%23comparison-chart)\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_1318d739
|
[
{
"role": "system",
"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 the price in the shelf or in the search results is different from the product 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/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-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/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-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/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-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/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-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/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-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/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting)\n\nDevelopment\n\nThe Price in the shelf or in the search results is different from the product page\n\nInconsistent pricing when comparing shelves or search results with product pages in stores using Intelligent Search.\n\n**Keywords:** Price | PDP | Product | SKU | Shelf | Search | Search Result | Promotion\n\nWhen [updating a SKU price](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/alteracao-de-preco-de-sku--tutorials%5F95) or applying a [promotion](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/promotion--6asfF1vFYiZgTQtOzwJchR), the price on the shelf or in the search results might differ from the price on the product page. This issue can happen in [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework) stores using the [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) component in the [store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme). This component receives and renders search results from [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb).\n\nThe Search Result component's configuration, specifically setting the `simulationBehavior` property to `skip`, can cause outdated prices to display in shelves and search results. This occurs because this configuration makes the component rely on cached data rather than fetching the latest price updates.\n\n> The `skip` setting is only recommended for stores where prices are not updated frequently and promotions are not used often. In these cases, this configuration can increase loading speed by displaying cached information. Learn more in [Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-displaying-asynchronous-prices).\n\n## Solution\n\nTo ensure consistent and up-to-date pricing across your store, follow the instructions below:\n\n1. Locate the theme files that define the [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) component.\n2. Locate the `simulationBehavior` property in your theme’s code, as in the example below. You can also find an example in the [store theme boilerplate](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme/blob/main/store/blocks/search.jsonc) repository. \n`1 \n\"store.search\": { \n2 \n \"blocks\": [ \n3 \n \"search-result-layout\" \n4 \n ], \n5 \n \"props\": { \n6 \n \"context\": { \n7 \n \"simulationBehavior\": \"skip\" \n8 \n } \n9 \n } \n10 \n} \n`\n3. Change the value of `simulationBehavior` from `skip` to `default`, as in the example below. This adjustment instructs the component always to fetch the latest data, eliminating the discrepancy caused by cached information. \n`1 \n\"store.search\": { \n2 \n \"blocks\": [ \n3 \n \"search-result-layout\" \n4 \n ], \n5 \n \"props\": { \n6 \n \"context\": { \n7 \n \"simulationBehavior\": \"default\" \n8 \n } \n9 \n } \n10 \n} \n`\n4. Run `vtex link` to see your changes reflected in the workspace.\n\nMake sure this change is applied consistently across all instances of the Search Result component used throughout your store's theme.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page.md)\n\n[Modal Layout closes when I click a SKU« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)[The promotion highlight flag does not appear on the productNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page%23solution)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page%23solution)\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_23c79de7
|
[
{
"role": "system",
"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 creating a new section 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-creating-a-new-section/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-creating-a-new-section/docs/api-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-creating-a-new-section/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-creating-a-new-section/docs/storefront-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-creating-a-new-section/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-creating-a-new-section/docs/troubleshooting)\n\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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/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-creating-a-new-section/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/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-creating-a-new-section/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/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-creating-a-new-section/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/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-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-overview)\n\nCreating a new section\n\nIn this guide, you will learn how to create a new section for your storefront and make it available in the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview). This solution is useful when your project requires a section not natively available in FastStore.\n\nFor this guide, we will create two sections:\n\n* `Call to Action` Gets a specific action from the user.\n* `OurStores`: Indicates the closest store for the user. \n> Sections are page components that wrap up other components, enabling you to create cohesive and functional content for your store. For example, the Hero section is a native section that includes the following components: `Hero`, `HeroImage`, and `HeroHeader`.\n\n## Before you begin\n\n### 1\\. Integrate the store with the Headless CMS\n\nAll sections must be available in the Headless CMS so they can be added and managed on your store's pages. To integrate your FastStore project, please refer to the [Headless CMS integration track](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account).\n\n### 2\\. Knowledge of how sections and content types work on Headless CMS\n\nDuring the creation of a new section, you will create files such as `sections.json` and `content-types.json`, which follow a structure established for the Headless CMS.\n\n### 3\\. Install the FastStore CLI\n\nMake sure to install the FastStore CLI to use its commands locally. Refer to the [FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli) guide for more information.\n\n## `Call to Action`\n\n### Step 1: Creating folders and files related to the Headless CMS\n\n1. In the FastStore root directory, create a folder named `cms`.\n2. Inside `cms`, create the `faststore` folder.\n3. Within the `cms/faststore` folder, create `sections.json` file.\n4. In the `sections.json` file, add the new section that you want to display in the Headless CMS. The schema below defines how the Headless CMS renders a section:\n\nsections.json\n\n`1\n\n [ \n\n2\n\n { \n\n3\n\n \"name\": \"CallToAction\", \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Call To Action\", \n\n6\n\n \"description\": \"Get your 20% off on the first purchase!\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [ \n\n9\n\n \"title\", \n\n10\n\n \"link\" \n\n11\n\n ], \n\n12\n\n \"properties\": { \n\n13\n\n \"title\": { \n\n14\n\n \"title\": \"Title\", \n\n15\n\n \"type\": \"string\" \n\n16\n\n }, \n\n17\n\n \"link\": { \n\n18\n\n \"title\": \"Link Path\", \n\n19\n\n \"type\": \"object\", \n\n20\n\n \"required\": [ \n\n21\n\n \"text\", \n\n22\n\n \"url\" \n\n23\n\n ], \n\n24\n\n \"properties\": { \n\n25\n\n \"text\": { \n\n26\n\n \"title\": \"Text\", \n\n27\n\n \"type\": \"string\" \n\n28\n\n }, \n\n29\n\n \"url\": { \n\n30\n\n \"title\": \"URL\", \n\n31\n\n \"type\": \"string\" \n\n32\n\n } \n\n33\n\n } \n\n34\n\n } \n\n35\n\n } \n\n36\n\n } \n\n37\n\n } \n\n38\n\n ] \n\n`\n\n> This new section receives a title and a link pointing to a specific location.\n\n### Step 2: Creating the new section\n\nTo render the `CallToAction` section you created in the previous step, you need to create this section component.\n\n1. If you don't already have it, create a folder named `components` inside the `src` directory.\n2. Inside the `components` folder, create a file named `CallToAction.tsx` and add the following code:\n\nsrc/components/CallToAction.tsx\n\n`1\n\nimport React from \"react\"; \n\n2\n\n \n3\n\nexport interface CallToActionProps { \n\n4\n\n title: string; \n\n5\n\n link: { \n\n6\n\n text: string; \n\n7\n\n url: string; \n\n8\n\n }; \n\n9\n\n} \n\n10\n\n \n11\n\nexport default function CallToAction(props: CallToActionProps) { \n\n12\n\n return ( \n\n13\n\n <section> \n\n14\n\n <h2>{props.title}</h2> \n\n15\n\n <a href={props.link.url}>{props.link.text}</a> \n\n16\n\n </section> \n\n17\n\n ); \n\n18\n\n} \n\n`\n\nThis section will receive the `link` and `title` defined previously in the `sections.json` file.\n\n1. Create a file named `index.tsx` inside the components folder.\n\n> The `index.tsx` file provides an entry point for importing and using the `CallToAction` component. It acts as a container for all the components within the components folder and allows for easier organization and reusability of code.\n\nOpen the `index.tsx` file and add the following code:\n\nsrc/components/index.tsx\n\n`1\n\nimport CallToAction from './CallToAction' \n\n2\n\n \n3\n\nexport default { CallToAction } \n\n`\n\n### Step 3: Synchronizing the new section with the Headless CMS\n\n1. In the terminal, run `faststore cms-sync`. This command will synchronize the new section you created with the CMS.\n2. Go to the VTEX Admin and access **Storefront > Headless CMS**.\n3. Click on the `Page` content type.\n\n\n\n1. In the `Sections` tab, click the `+`, search for the new `Call to Action` section, and add it to your page.\n\n\n\n## `OurStore`\n\n1. After [creating the files and folders](#step-1-creating-folders-and-files-related-to-the-headless-cms), In the `sections.json` file, add the new section that you want to display in the Headless CMS. The schema below defines how the Headless CMS renders the `OurStores` section that we will use in the example:\n\nsections.json\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"name\": \"OurStores\", \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Our Stores\", \n\n6\n\n \"description\": \"Search stores near to the users\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [\"title\", \"description\"], \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 \"default\": \"Explore Nearby Stores\" \n\n14\n\n }, \n\n15\n\n \"description\": { \n\n16\n\n \"title\": \"Link Path\", \n\n17\n\n \"type\": \"string\", \n\n18\n\n \"default\": \"Discover the closest store to you and pay us a visit.\" \n\n19\n\n } \n\n20\n\n } \n\n21\n\n } \n\n22\n\n } \n\n23\n\n] \n\n`\n\n1. Inside the `components` folder, create a file named `OurStores.tsx` and add the following code:\n\nsrc/components/OurStores.tsx\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { Button, Icon, SelectField } from '@faststore/ui' \n\n3\n\n \n4\n\nexport interface OurStoresProps { \n\n5\n\n title: string \n\n6\n\n description: string \n\n7\n\n} \n\n8\n\n \n9\n\nexport default function OurStores(props: OurStoresProps) { \n\n10\n\n return ( \n\n11\n\n <section> \n\n12\n\n <h2>{props.title}</h2> \n\n13\n\n <p>{props.description}</p> \n\n14\n\n <div> \n\n15\n\n <SelectField \n\n16\n\n id=\"select-state-store\" \n\n17\n\n label=\"State:\" \n\n18\n\n options={{ \n\n19\n\n newYork: 'New York', \n\n20\n\n arizona: 'Arizona', \n\n21\n\n massachusetts: 'Massachusetts', \n\n22\n\n hawaii: 'Hawaii', \n\n23\n\n }} \n\n24\n\n /> \n\n25\n\n <SelectField \n\n26\n\n id=\"select-city-store\" \n\n27\n\n label=\"City:\" \n\n28\n\n options={{ \n\n29\n\n newYorkCity: 'New York City', \n\n30\n\n phoenix: 'Phoenix', \n\n31\n\n boston: 'Boston', \n\n32\n\n honolulu: 'Honolulu', \n\n33\n\n }} \n\n34\n\n /> \n\n35\n\n <Button \n\n36\n\n variant=\"secondary\" \n\n37\n\n icon={<Icon name=\"ArrowRight\" />} \n\n38\n\n iconPosition=\"right\" \n\n39\n\n > \n\n40\n\n Find Store \n\n41\n\n </Button> \n\n42\n\n </div> \n\n43\n\n </section> \n\n44\n\n ) \n\n45\n\n} \n\n`\n\nFor this section, we will use the following components from the Faststore UI: [Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button), [Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon) and [SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules/select-field).\n\n1. Create a file named `index.tsx` inside the components folder, and add the following code:\n\nsrc/components/index.tsx\n\n`1\n\nimport OurStores from './OurStores' \n\n2\n\n \n3\n\nexport default { OurStores } \n\n`\n\n1. Repeat the steps in [Step 3: Synchronizing the new section with the Headless CMS](#step3-synchronizing-the-new-section-with-the-headless-cms), and you should see the new section but without styles as in the example below:\n\n\n\nTo add styles to `OurStore`, refer to the following section [Importing styles when creating a new section](#importing-styles-when-creating-a-new-section).\n\n## Adding styles to a new section\n\nAfter creating a new section, you can style it to match your store's branding. Follow the steps below using the [OurStores](#ourstores) section as an example.\n\n### Instructions\n\n1. In your store code, open the `components` folder and create a `.module.scss` file for your component. For example, if your component is `OurStores`, name the file `ourStores.module.scss`. This file will contain the styles specific to this section.\n2. Import the necessary FastStore UI styles into your `.module.scss` file. For example, to style the `OurStores` component, we imported the styles for the [Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button) and [SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field) components. The `Select` styles are also imported since `SelectField` inherits them.\n\n`1\n\n.ourStores { \n\n2\n\n @import '@faststore/ui/src/components/atoms/Button/styles.scss'; \n\n3\n\n @import '@faststore/ui/src/components/atoms/Select/styles.scss'; \n\n4\n\n @import '@faststore/ui/src/components/molecules/SelectField/styles.scss'; \n\n5\n\n} \n\n`\n\n1. Open the component's `.tsx` file. For example, `OurStores.tsx`.\n2. Import the newly created stylesheet into the component:\n\n```` 1\n\nimport React from 'react' \n\n2\n\nimport { Button, Icon, SelectField } from '@faststore/ui' \n\n3\n\n \n4\n\nimport styles from './ourStores.module.scss' ``` \n\n5\n\n \n6\n\n5. Apply the styles to your components using `className={styles.<className>}`. Replace `<className>` with the appropriate class name defined in your stylesheet. For example: \n\n7\n\n ```tsx mark=13 \n\n8\n\n import React from 'react' \n\n9\n\n import { Button, Icon, SelectField } from '@faststore/ui' \n\n10\n\n \n11\n\n import styles from './ourStores.module.scss' \n\n12\n\n \n13\n\n export interface OurStoresProps { \n\n14\n\n title: string \n\n15\n\n description: string \n\n16\n\n } \n\n17\n\n \n18\n\n export default function OurStores(props: OurStoresProps) { \n\n19\n\n return ( \n\n20\n\n <section className={styles.ourStores}> \n\n21\n\n <h2>{props.title}</h2> \n\n22\n\n <p>{props.description}</p> \n\n23\n\n <div> \n\n24\n\n <SelectField \n\n25\n\n id=\"select-state-store\" \n\n26\n\n label=\"State:\" \n\n27\n\n options={{ \n\n28\n\n newYork: 'New York', \n\n29\n\n arizona: 'Arizona', \n\n30\n\n massachusetts: 'Massachusetts', \n\n31\n\n hawaii: 'Hawaii', \n\n32\n\n }} \n\n33\n\n /> \n\n34\n\n <SelectField \n\n35\n\n id=\"select-city-store\" \n\n36\n\n label=\"City:\" \n\n37\n\n options={{ \n\n38\n\n newYorkCity: 'New York City', \n\n39\n\n phoenix: 'Phoenix', \n\n40\n\n boston: 'Boston', \n\n41\n\n honolulu: 'Honolulu', \n\n42\n\n }} \n\n43\n\n /> \n\n44\n\n <Button \n\n45\n\n variant=\"secondary\" \n\n46\n\n icon={<Icon name=\"ArrowRight\" />} \n\n47\n\n iconPosition=\"right\" \n\n48\n\n > \n\n49\n\n Find Store \n\n50\n\n </Button> \n\n51\n\n </div> \n\n52\n\n </section> \n\n53\n\n ) \n\n54\n\n } \n\n ````\n\n1. Open the terminal and run `yarn dev` to see your changes.\n\n\n\n1. Add more styles to the section by using [design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-overview%23global-tokens) and [component-specific data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button%23customization) to the `.module.scss` file:\n\n`1\n\n.ourStores { \n\n2\n\n @import '@faststore/ui/src/components/atoms/Button/styles.scss'; \n\n3\n\n @import '@faststore/ui/src/components/atoms/Select/styles.scss'; \n\n4\n\n @import '@faststore/ui/src/components/molecules/SelectField/styles.scss'; \n\n5\n\n \n6\n\n width: 100%; \n\n7\n\n display: flex; \n\n8\n\n flex-direction: column; \n\n9\n\n justify-content: center; \n\n10\n\n align-items: center; \n\n11\n\n padding: var(--fs-spacing-5); \n\n12\n\n margin: auto; \n\n13\n\n background-color: var(--fs-color-neutral-bkg); \n\n14\n\n \n15\n\n [data-fs-select-field] { \n\n16\n\n flex-direction: column; \n\n17\n\n align-items: flex-start; \n\n18\n\n \n19\n\n [data-fs-select] { \n\n20\n\n border: var(--fs-border-width) solid var(--fs-border-color); \n\n21\n\n margin-top: var(--fs-spacing-0); \n\n22\n\n width: 10rem; \n\n23\n\n height: var(--fs-control-min-height); \n\n24\n\n \n25\n\n select { \n\n26\n\n width: 100%; \n\n27\n\n } \n\n28\n\n } \n\n29\n\n } \n\n30\n\n} \n\n31\n\n \n32\n\n.ourStores__title { \n\n33\n\n font-size: var(--fs-text-size-title-section); \n\n34\n\n margin-bottom: var(--fs-spacing-1); \n\n35\n\n} \n\n36\n\n \n37\n\n.ourStores__content { \n\n38\n\n display: flex; \n\n39\n\n align-items: flex-end; \n\n40\n\n column-gap: var(--fs-spacing-5); \n\n41\n\n margin: var(--fs-spacing-5); \n\n42\n\n} \n\n`\n\n1. Update the component's file by adding the appropriate CSS classes to elements, ensuring they align with the newly defined styles in your stylesheet. For example:\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { Button, Icon, SelectField } from '@faststore/ui' \n\n3\n\n \n4\n\nimport styles from './ourStores.module.scss' \n\n5\n\n \n6\n\nexport interface OurStoresProps { \n\n7\n\n title: string \n\n8\n\n description: string \n\n9\n\n} \n\n10\n\n \n11\n\nexport default function OurStores(props: OurStoresProps) { \n\n12\n\n return ( \n\n13\n\n <section className={styles.ourStores}> \n\n14\n\n <h2 className={styles.ourStores__title}>{props.title}</h2> \n\n15\n\n <p>{props.description}</p> \n\n16\n\n <div className={styles.ourStores__content}> \n\n17\n\n <SelectField \n\n18\n\n id=\"select-state-store\" \n\n19\n\n label=\"State:\" \n\n20\n\n options={{ \n\n21\n\n newYork: 'New York', \n\n22\n\n arizona: 'Arizona', \n\n23\n\n massachusetts: 'Massachusetts', \n\n24\n\n hawaii: 'Hawaii', \n\n25\n\n }} \n\n26\n\n /> \n\n27\n\n <SelectField \n\n28\n\n id=\"select-city-store\" \n\n29\n\n label=\"City:\" \n\n30\n\n options={{ \n\n31\n\n newYorkCity: 'New York City', \n\n32\n\n phoenix: 'Phoenix', \n\n33\n\n boston: 'Boston', \n\n34\n\n honolulu: 'Honolulu', \n\n35\n\n }} \n\n36\n\n /> \n\n37\n\n <Button \n\n38\n\n variant=\"secondary\" \n\n39\n\n icon={<Icon name=\"ArrowRight\" />} \n\n40\n\n iconPosition=\"right\" \n\n41\n\n > \n\n42\n\n Find Store \n\n43\n\n </Button> \n\n44\n\n </div> \n\n45\n\n </section> \n\n46\n\n ) \n\n47\n\n} \n\n`\n\n1. Navigate to `http://localhost:3000` in your browser to see the updated component with the applied styles.\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/creating-a-new-section.mdx)\n\n[Adding an image to the Alert component« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides//faststore/override-use-cases-adding-an-image-to-the-alert-component)[List of native sections and overridable componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\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/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23before-you-begin)\n\n[1\\. Integrate the store with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%231-integrate-the-store-with-the-headless-cms)[2\\. Knowledge of how sections and content types work on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%232-knowledge-of-how-sections-and-content-types-work-on-headless-cms)[3\\. Install the FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%233-install-the-faststore-cli)\n\n[Call to Action](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23call-to-action)\n\n[Step 1: Creating folders and files related to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-1-creating-folders-and-files-related-to-the-headless-cms)[Step 2: Creating the new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-2-creating-the-new-section)[Step 3: Synchronizing the new section with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-3-synchronizing-the-new-section-with-the-headless-cms)\n\n[OurStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23ourstore)\n\n[Adding styles to a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23adding-styles-to-a-new-section)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%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/creating-a-new-section.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/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23before-you-begin)\n\n[1\\. Integrate the store with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%231-integrate-the-store-with-the-headless-cms)[2\\. Knowledge of how sections and content types work on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%232-knowledge-of-how-sections-and-content-types-work-on-headless-cms)[3\\. Install the FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%233-install-the-faststore-cli)\n\n[Call to Action](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23call-to-action)\n\n[Step 1: Creating folders and files related to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-1-creating-folders-and-files-related-to-the-headless-cms)[Step 2: Creating the new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-2-creating-the-new-section)[Step 3: Synchronizing the new section with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23step-3-synchronizing-the-new-section-with-the-headless-cms)\n\n[OurStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23ourstore)\n\n[Adding styles to a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%23adding-styles-to-a-new-section)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section%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=)"
}
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.