id
stringlengths 12
53
| messages
listlengths 3
3
|
|---|---|
doc_13cecaa8
|
[
{
"role": "system",
"content": "You are a VTEX 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 graphql api list in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/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-graphql-api-list/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/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-graphql-api-list/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/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-graphql-api-list/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/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-graphql-api-list/docs/app-development)\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list/docs/guides/vtex-io-graphql-api-list)\n\nList of GraphQL APIs\n\nSee how to use GraphQL APIs of VTEX Apps.\n\n| Name | Description |\n| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [B2B Organizations GraphQL API](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/b2b-organizations-graphql/blob/master/graphql/schema.graphql) | Manages B2B users into organizations. Users in the same organization share the same commercial conditions such as specific payment methods, price tables, and product collections. This is part of the [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite). |\n| [B2B Quotes GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api) | Manages quotes in a B2B environment. This is part of the [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite). |\n| [External Marketplace Integration GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api) | Defines the requirements for integrating an [external marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide) into VTEX. |\n| [Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api) | Manages the internationalization of messages in different store contexts. |\n| [Rewriter GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api) | Manages internal URLs and URL redirects. |\n| [Search GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql) | Makes catalog searches in VTEX stores. |\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) | 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. |\n| [Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api) | Defines the requirements for integrating a [tax service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview) into VTEX. |\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/GraphQL/vtex-io-graphql-api-list.md)\n\n[GraphQL in VTEX IO« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list//docs/guides/graphql-in-vtex-io)[Developing a GraphQL API in service appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list//docs/guides/developing-a-graphql-api-in-service-apps)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/GraphQL/vtex-io-graphql-api-list.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_05e44dea
|
[
{
"role": "system",
"content": "You are a VTEX 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 rich text in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-rich-text/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/api-reference)\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-rich-text/docs/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-rich-text/docs/storefront-development)\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-rich-text/docs/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-rich-text/docs/troubleshooting)\n\n[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-rich-text/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/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-rich-text/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/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-rich-text/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-rich-text/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/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-rich-text/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-rich-text/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/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-rich-text/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/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-rich-text/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-rich-text/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/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-rich-text/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-rich-text/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-rich-text/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/guides/basic-components)\n\nRich Text\n\nOfficial extension\n\nVersion: 0.16.1\n\nLatest version: 0.16.1\n\nThe Rich Text block converts text written in Markdown to HTML and displays it on your storefront.\n\n\n\nFor example, the following Markdown content\n\n`1\n\n[Help](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/welcome).\\n**Be Bold!**\\n*This is italic* \n\n`\n\nwould be rendered as\n\n`1\n\n<div> \n\n2\n\n <p> \n\n3\n\n <a href=\"https://developers.vtex.com/\">Help</a><br /> \n\n4\n\n <span class=\"b\">Be Bold!</span><br /> \n\n5\n\n <span class=\"i\">This is italic</span> \n\n6\n\n </p> \n\n7\n\n</div> \n\n`\n\nLearn more in [Markdown documentation](https://read.calvincode.net/reader?url=https://www.markdownguide.org/cheat-sheet/).\n\n## Configuration\n\n1. Add the `rich-text` app to your theme’s dependencies in the `manifest.json` file:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.rich-text\": \"0.x\" \n\n3\n\n } \n\n`\n\n1. Add the `rich-text` block to your block files in the desired template position. Example:\n\n`1\n\n\"rich-text\": { \n\n2\n\n \"props\": { \n\n3\n\n \"textAlignment\": \"CENTER\", \n\n4\n\n \"textPosition\": \"CENTER\", \n\n5\n\n \"text\": \"Visit our [help](https://read.calvincode.net/reader?url=https://developers.vtex.com/) section.\\n**Be Bold!**\\n*This is italic*\", \n\n6\n\n \"textColor\": \"c-on-emphasis\", \n\n7\n\n \"font\": \"t-heading-5\", \n\n8\n\n \"blockClass\": \"help-message\" \n\n9\n\n } \n\n10\n\n} \n\n`\n\n## Props\n\n| Prop name | Type | Description |\n| ------------- | ----------------- | --------------------------------------------------------- |\n| blockClass | string | Unique class name appended to block classes. Default: '' |\n| font | string | Tachyon token used as font. Default: t-body. |\n| htmlId | String | HTML ID of the element. |\n| textColor | string | Tachyon token used as text color. Default: c-on-base. |\n| text | string | Text written in Markdown. |\n| textAlignment | TextAlignmentEnum | Text alignment inside the component. Default: \"LEFT\". |\n| textPosition | TextPostionEnum | Text position relative to the component. Default: \"LEFT\". |\n\n* **`TextAlignmentEnum` possible values**\n\n| Enum name | Enum value | Description |\n| --------- | ---------- | -------------------------- |\n| Left | 'LEFT' | Aligns text to the left. |\n| Center | 'CENTER' | Aligns text to the center. |\n| Right | 'RIGHT' | Aligns text to the right. |\n\n* **`TextPostionEnum` possible values**\n\n| Enum name | Enum value | Description |\n| --------- | ---------- | ------------------------------------------------------------ |\n| Left | 'LEFT' | Positions content at the left of the component. |\n| Center | 'CENTER' | Positions content at the horizontal center of the component. |\n| Right | 'RIGHT' | Positions content at the right of the component. |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the guide [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handle |\n| ------------- |\n| container |\n| heading |\n| headingLevel1 |\n| headingLevel2 |\n| headingLevel3 |\n| headingLevel4 |\n| headingLevel5 |\n| headingLevel6 |\n| image |\n| italic |\n| link |\n| list |\n| listItem |\n| listOrdered |\n| paragraph |\n| strong |\n| table |\n| tableBody |\n| tableHead |\n| tableTd |\n| tableTh |\n| tableTr |\n| wrapper |\n\n[Product Summary SKU Name« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.product-summary/productsummaryskuname)[SearchNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.search)\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-rich-text/docs/apps/vtex.rich-text%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.rich-text%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/docs/apps/vtex.rich-text%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_dd63dcab
|
[
{
"role": "system",
"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 buyer organizations 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/buyer-organizations/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/api-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/buyer-organizations/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/buyer-organizations/docs/storefront-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/buyer-organizations/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/buyer-organizations/docs/troubleshooting)\n\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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/api-reference/buyer-organizations/)\n\nBulk Import\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/api-reference/buyer-organizations/)\n\nBulk Import\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/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/buyer-organizations/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/buyer-organizations/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/buyer-organizations/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[DeDelete price table mapping« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/api-reference/audience-api%23delete-/api/price-table-mapper/pvt/mapping/-audienceId-)[PoUpload fileNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations/docs/api-reference/buyer-organizations%23post-/api/b2b/import/buyer-orgs)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_9e8c0f8d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore molecules search top in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-overview)\n\nSearchTop\n\nDisplays the most searched terms by customers.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/SearchTop)\n\nThis section displays the most searched terms by customers. This component is part of the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search) feature.\n\nExample\n\nCode\n\nTop Search\n\n1. [1Notebooks](#)\n2. [2Laser Printer](#)\n3. [3Bluetooth Keyboard](#)\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { SearchTop, SearchTopTerm } from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/molecules/SearchTop/styles.scss\"; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ------------------------------------ | ---------------------------------- |\n| \\--fs-search-top-padding-top | var(--fs-spacing-2) |\n| \\--fs-search-top-padding-right | var(--fs-spacing-3) |\n| \\--fs-search-top-padding-bottom | var(--fs-search-top-padding-top) |\n| \\--fs-search-top-padding-left | var(--fs-search-top-padding-right) |\n| \\--fs-search-top-transition-property | var(--fs-transition-property) |\n| \\--fs-search-top-transition-function | var(--fs-transition-function) |\n| \\--fs-search-top-transition-timing | var(--fs-transition-timing) |\n\n### Header\n\n| Local token | Default value/Global token linked |\n| -------------------------------------- | --------------------------------------- |\n| \\--fs-search-top-header-padding-top | var(--fs-spacing-1) |\n| \\--fs-search-top-header-padding-bottom | var(--fs-search-top-header-padding-top) |\n\n### Title\n\n| Local token | Default value/Global token linked |\n| ---------------------------------- | --------------------------------- |\n| \\--fs-search-top-title-size | var(--fs-text-size-lead) |\n| \\--fs-search-top-title-line-height | 1.5 |\n\n### Item\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | ---------------------------------- |\n| \\--fs-search-top-item-column-gap | var(--fs-spacing-1) |\n| \\--fs-search-top-item-text-size | var(--fs-text-size-2) |\n| \\--fs-search-top-item-line-height | 1.25 |\n| \\--fs-search-top-item-bkg-color-hover | var(--fs-color-tertiary-bkg-hover) |\n\n---\n\n## Data attributes\n\nYou can target and override `SearchTop` styles using the following data attributes:\n\n`data-fs-search-top`\n\n`data-fs-search-top-header`\n\n`data-fs-search-top-title`\n\n`data-fs-search-top-item`\n\n`data-fs-search-top-item-link`\n\n`data-fs-search-top-item-badge`\n\n---\n\n## Props\n\n### SearchTop\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-top-search |\n| **title** | string | Title attribute for the <section> tag rendered by this component. | Top Search |\n\n### SearchTopTerm\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-top-search-term |\n| **value\\*** | string | Search term to be shown. | |\n| **linkProps** | Partial<LinkProps<LinkElementType>> | Props for the \\`<Link>\\` rendered by this component. | |\n| **index\\*** | number | Current term's position in a list of search terms. | |\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/search-top.mdx)\n\n[SearchProducts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-products)[SelectFieldNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-select-field)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23design-tokens)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23header)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23title)[Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23item)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23props)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23searchtop)[SearchTopTerm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23searchtopterm)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/search-top.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23design-tokens)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23header)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23title)[Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23item)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23props)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23searchtop)[SearchTopTerm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-top/docs/guides/faststore/molecules-search-top%23searchtopterm)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_50e2291b
|
[
{
"role": "system",
"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 customer credit 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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-api/docs/api-reference/customer-credit-api/)\n\nAccount\n\nInvoices\n\nStore configuration\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-api/docs/api-reference/customer-credit-api/)\n\nAccount\n\nInvoices\n\nStore configuration\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-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/customer-credit-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeGet sellers by region or address« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api/docs/api-reference/checkout-api%23get-/api/checkout/pub/regions/-regionId-)[GeSearch all accountsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_57cc5a0d
|
[
{
"role": "system",
"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 sandbox 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.sandbox/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/api-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.sandbox/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.sandbox/docs/storefront-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.sandbox/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.sandbox/docs/troubleshooting)\n\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.sandbox/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/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.sandbox/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/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.sandbox/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.sandbox/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/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.sandbox/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/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.sandbox/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/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.sandbox/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.sandbox/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/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.sandbox/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/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.sandbox/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.sandbox/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/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.sandbox/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/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.sandbox/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/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.sandbox/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.sandbox/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.sandbox/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/guides/advanced-components)\n\nVTEX IO Sandbox Component\n\nOfficial extension\n\nVersion: 0.5.1\n\nLatest version: 0.5.1\n\n[](#contributors-)\n\nAllows mounting arbitrary HTML content in extension points from the comfort and safety of an iframe.\n\n### Example block\n\n`1\n\n \"sandbox.product\": { \n\n2\n\n \"props\": { \n\n3\n\n \"width\": \"200px\", \n\n4\n\n \"height\": \"60px\", \n\n5\n\n \"initialContent\": \"<script src='https://unpkg.com/jquery@3.3.1/dist/jquery.min.js'></script><h1 id='test'>initial</h1><script>function render(){ current = window.props.productQuery.product.items.findIndex(function(p){ return p.itemId === window.props.query.skuId }); if (current === -1) {current = 0}; $('#test').html(window.props.productQuery.product.items[current].sellers[0].commertialOffer.ListPrice)}; window.addEventListener('message', function(e){ console.log('got message in product', e.data, window.props); render();});</script>\", \n\n6\n\n \"allowCookies\": true \n\n7\n\n } \n\n8\n\n }, \n\n9\n\n \"sandbox.order\": { \n\n10\n\n \"props\": { \n\n11\n\n \"width\": \"200px\", \n\n12\n\n \"height\": \"60px\", \n\n13\n\n \"initialContent\": \"<script>console.log('Current orderForm: ', window.props.orderForm)</script>\", \n\n14\n\n \"allowCookies\": true \n\n15\n\n } \n\n16\n\n }, \n\n17\n\n \"sandbox#home\": { \n\n18\n\n \"props\": { \n\n19\n\n \"width\": \"200px\", \n\n20\n\n \"height\": \"60px\", \n\n21\n\n \"initialContent\": \"<h1 id='test'>home</h1><script>console.log(props, document.cookie); window.addEventListener('message', function(e){ console.log('got message in home', window.props) });</script>\", \n\n22\n\n \"allowCookies\": true \n\n23\n\n } \n\n24\n\n }, \n\n25\n\n \"store.home\": { \n\n26\n\n \"blocks\": [\"carousel#home\", \"shelf#home\", \"sandbox#home\"] \n\n27\n\n }, \n\n28\n\n \"store.product\": { \n\n29\n\n \"blocks\": [ \n\n30\n\n \"product-details#default\", \n\n31\n\n \"sandbox#product\" \n\n32\n\n ] \n\n33\n\n }, \n\n`\n\n[Video« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.store-video)[Shipping Option ComponentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.shipping-option-components)\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[Example block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sandbox/docs/apps/vtex.sandbox%23example-block)\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_1b90df17
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference vtex shipping network api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-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/vtex-shipping-network-api/docs/api-reference/vtex-shipping-network-api/)\n\nNotification\n\nTracking\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-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/vtex-shipping-network-api/docs/api-reference/vtex-shipping-network-api/)\n\nNotification\n\nTracking\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoGet ads« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/vtex-ads-api%23post-/v1/rma/-publisher%5Fid-)[PoNotify Carrier with AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api/docs/api-reference/vtex-shipping-network-api%23post-/-app%5Fname-/v-app%5Fversion-/-account-/-workspace-/notify)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_c73db791
|
[
{
"role": "system",
"content": "You are a VTEX 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 7 using graphiql in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-7-using-graphiql/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/api-reference)\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-7-using-graphiql/docs/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-7-using-graphiql/docs/storefront-development)\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-7-using-graphiql/docs/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-7-using-graphiql/docs/troubleshooting)\n\n[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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/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-7-using-graphiql/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/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-7-using-graphiql/docs/guides/developing-services-on-vtex-io)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/guides/services-7-using-graphiql)\n\n7\\. Using GraphiQL\n\nNow that you've implemented the GraphQL query and its resolver, it's time to put it to the test using [GraphiQL](https://read.calvincode.net/reader?url=https://github.com/graphql/graphiql), an in-browser GraphQL IDE. Follow the steps below to efficiently experiment with your GraphQL queries.\n\n## Accessing the GraphiQL IDE\n\nNavigate to the GraphQL route prompted in the terminal after linking your app. The GraphiQL interface consists of three main areas: the coding area, the query variables area, and the debug area, as illustrated below.\n\n\n\n## Writing the query\n\nIn the coding area, enter the GraphQL query provided in the right panel. This query is designed to retrieve information about the `topN` most viewed products, including their `slug` (product identifier) and `count` (number of views).\n\n## Using query variables\n\nSince the declared query involves a variable (`topN`), declare it in the _Query Variables_ area located beneath the coding area. You can expand this area by dragging its title.\n\n## Running the query\n\nClick the `Play` button to execute the code, and check the outcome in the debug area.\n\n\n\nTerminal\n\n`1\n\n17:31:10.803 -info: Build accepted for vtex.service-course-template@0.0.1 at myaccount/myworkspace vtex.builder-hub@0.250.0 \n\n2\n\n17:31:10.818 - info: Starting build for app vtex.service-course-template@0.0.1 vtex.builder-hub@0.250.0 \n\n3\n\n17:31:19.588 - warn: node builder overrode the following options in tsconfig.json: target: 'es2017' = 'es2019' vtex.builder-hub@0.250.0 \n\n4\n\n17:31:27.227 - info: Bundle: 26 files - 34.44MB vtex.builder-hub@0.250.0 \n\n5\n\n17:31:27.228 - info: Sent bundle to Apps in 3869ms vtex.builder-hub@0.250.0 \n\n6\n\n17:31:27.229 - info:App linked successfully vtex.builder-hub@0.250.0 \n\n7\n\n17:31:27.230 - info: You can try out the queries in this app using the GraphiQLIDE available at: \n\n8\n\nhttps://myworkspace--myaccount.myvtex.com/_v/private/vtex.service-course-template@0.0.1/graphiql/v1 vtex.builder-hub@0.250.0 \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-7-using-graphiql.mdx)\n\n[6\\. Using GraphQL to retrieve data from Master Data« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql//docs/guides/services-6-graphql-retrieving-data-from-master-data)[Services - ConclusionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql//docs/guides/services-conclusion)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Accessing the GraphiQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/guides/services-7-using-graphiql%23accessing-the-graphiql-ide)\n\n[Writing the query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/guides/services-7-using-graphiql%23writing-the-query)\n\n[Using query variables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/guides/services-7-using-graphiql%23using-query-variables)\n\n[Running the query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/guides/services-7-using-graphiql%23running-the-query)\n\nWas this helpful?\n\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-7-using-graphiql.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Accessing the GraphiQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/guides/services-7-using-graphiql%23accessing-the-graphiql-ide)\n\n[Writing the query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/guides/services-7-using-graphiql%23writing-the-query)\n\n[Using query variables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/guides/services-7-using-graphiql%23using-query-variables)\n\n[Running the query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql/docs/guides/services-7-using-graphiql%23running-the-query)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b2f18554
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting i am getting errors with my service configuration 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/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-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/troubleshooting/i-am-getting-errors-with-my-service-configuration-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/troubleshooting/i-am-getting-errors-with-my-service-configuration-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/troubleshooting/i-am-getting-errors-with-my-service-configuration-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/troubleshooting/i-am-getting-errors-with-my-service-configuration-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/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/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/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting)\n\nDevelopment\n\nI am getting errors with my service configuration app\n\nErrors with the service configuration app occur depending on your workspace configuration\n\nIf you are [developing a configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps), you may be getting errors because the service your app is configuring is installed or linked to a different workspace. This happens because, when creating a new configuration app, the configuration builder first looks for that configuration schema in all the apps installed in your current workspace. Consequently, linking your app may fail if the configuration builder cannot find this specific configuration.\n\n## Solution\n\nBelow, we outline solutions for addressing errors with your service configuration app:\n\n1. [Avoid errors when installing or linking your configuration app](#avoiding-errors-when-installing-or-linking-your-configuration-app).\n2. [Publish your configuration app in an alternative workspace](#publishing-your-configuration-app-in-an-alternative-workspace).\n\n### Avoiding errors when installing or linking your configuration app\n\nTo avoid errors, link or install the configuration app in the same workspace the service app is linked or installed. Follow the instructions below:\n\n1. In a terminal, go to the desired workspace using the following VTEX IO CLI command: \n`1 \nvtex use workspace {desiredWorkspace} \n` \n> Replace {desiredWorkspace} with the workspace you want to work in.\n2. If your service app is not yet linked or installed, [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) or [install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) your service app.\n3. [Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) or [install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) your configuration app.\n\n### Publishing your configuration app in an alternative workspace\n\nTo publish your configuration app without installing the service in the master workspace, follow the instructions below:\n\n1. In a terminal, go to the desired workspace using the following VTEX IO CLI command: \n`1 \nvtex use workspace {desiredWorkspace} \n` \nReplace `{desiredWorkspace}` with the workspace you want to work in.\n2. If your service app is not yet linked or installed, [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) or [install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) your service app.\n3. Create a new version of your configuration app by following the instructions in [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).\n4. [Publish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) your configuration app using the following command: \n`1 \nvtex publish -w {desiredWorkspace} \n` \nThe `-w` flag allows you to choose the workspace of the app you are publishing.\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/i-am-getting-errors-with-my-service-configuration-app.md)\n\n[I am getting 500 errors in VTEX IO CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)[Issues during extending the FastStore API schemaNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\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/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23solution)\n\n[Avoiding errors when installing or linking your configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23avoiding-errors-when-installing-or-linking-your-configuration-app)[Publishing your configuration app in an alternative workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23publishing-your-configuration-app-in-an-alternative-workspace)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.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/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23solution)\n\n[Avoiding errors when installing or linking your configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23avoiding-errors-when-installing-or-linking-your-configuration-app)[Publishing your configuration app in an alternative workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23publishing-your-configuration-app-in-an-alternative-workspace)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_cdf80a1e
|
[
{
"role": "system",
"content": "You are a VTEX 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 clients in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-clients/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-clients/docs/api-reference)\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-clients/docs/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-clients/docs/storefront-development)\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-clients/docs/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-clients/docs/troubleshooting)\n\n[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-clients/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-clients/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-clients/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-clients/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-clients/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-clients/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-clients/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-clients/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-clients/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients)\n\n[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-how-to-create-and-use-clients)\n\n[Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)\n\n[Using Clients in Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/using-node-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/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/vtex-io-documentation-clients/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/vtex-io-documentation-clients/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/vtex-io-documentation-clients/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/vtex-io-documentation-clients/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-clients/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-clients/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/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-clients/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-clients/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-clients/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-clients/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/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-clients/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-clients/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-clients/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-clients/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-clients/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-clients/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-clients/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-clients/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients)\n\n[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-how-to-create-and-use-clients)\n\n[Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)\n\n[Using Clients in Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/using-node-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/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/vtex-io-documentation-clients/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/vtex-io-documentation-clients/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/vtex-io-documentation-clients/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/vtex-io-documentation-clients/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-clients/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-clients/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/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-clients/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-clients/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-clients/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-clients/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/app-development-guides)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients)\n\nClients\n\nLearn more about VTEX IO Clients and their advantages.\n\nClients serve as intermediaries that initiate and maintain interactions with both external and internal services. Whether interfacing with VTEX IO Services, VTEX Core Commerce APIs, or external APIs, Clients are crucial in enabling seamless communication and data exchange. This guide will explore the concept of Clients and provide a list of native Clients available in VTEX IO.\n\n## Understanding Clients\n\nClients are essentially configurations implemented within the VTEX IO platform to abstract and streamline communication with various services. They simplify the process of sending requests and receiving responses, acting as intermediaries between an app and the other services it relies on.\n\nIn simpler terms, think of Clients as the messengers of an app, responsible for reaching out to other services, gathering information, and returning it to your application.\n\n## Advantages of using Clients\n\nClients offer various advantages when it comes to managing interactions and data exchange between your app and other services. They ensure that your app functions effectively by handling the complexity of communication with other services.\n\nWhen developing VTEX IO apps, using Clients can help you manage and streamline complexity. Clients centralize communication logic, making it easier to maintain and scale your codebase. VTEX IO Clients come equipped with several built-in features that enhance the functionality and performance of your applications:\n\n* **Cache:** Clients incorporate caching mechanisms to store and retrieve data efficiently, reducing the load on services and improving response times.\n* **Native metrics support:** Clients integrate with performance monitoring and analytics tools, providing insights into service usage and performance.\n* **Retry and timeout options:** Clients offer configurable retry and timeout settings, ensuring robustness and resilience in the face of network issues or service unavailability.\n* **Billing tracking:** Clients can track usage and resource consumption, aiding in billing and cost optimization.\n\n## List of native Clients\n\nVTEX offers some native Clients, allowing developers to save time and effort when interacting with services such as VTEX Core Commerce APIs and other internal services.\n\n### `@vtex/clients`\n\nThe [@vtex/clients](https://read.calvincode.net/reader?url=https://github.com/vtex/io-clients) package provides the following clients for IO apps using the `node` Builder:\n\n| Client | Description | Methods |\n| ---------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| affiliate | Handles affiliate-related operations. | registerAffiliate, changeNotification, createSeller, getSellerList |\n| catalog | Handles catalog-related tasks such as retrieving product and SKU information. | getProductsAndSkus, getSkuById, changeNotification, createSeller, getSellerList, getSellerById, getSkuContext, getCategoryById, getBrandById |\n| checkout | Deals with order form configurations and custom Checkout data. | getOrderFormConfiguration, setOrderFormConfiguration, setSingleCustomData |\n| logistics | Manages logistics and inventory-related tasks. | getDockById, pickupById, listPickupPoints, nearPickupPoints, shipping, listInventoryBySku |\n| OMS | Handles order management operations. | listOrders, userLastOrder, order, orderNotification, cancelOrder |\n| omsApiProxy | Acts as a proxy for OMS API operations. | orders, orderFormId, customData, register |\n| ratesAndBenefits | Handles Rates and Benefits data. | getAllBenefits, getPromotionById, createOrUpdatePromotion, createMultipleSkuPromotion, updateMultipleSkuPromotion |\n| suggestions | Handles product suggestions and versions. | getAllSuggestions, getSuggestionById, sendSkuSuggestion, deleteSkuSuggestion, getAllVersions, getVersionById |\n\n| Factory | Description | Methods |\n| ---------- | ------------------------------------ | --------------------------------------------------------------------------------------- |\n| masterData | Interacts with Master Data services. | get, save, update, saveOrUpdate, saveOrUpdatePartial, delete, search, searchRaw, scroll |\n| vbase | Interacts with VBase services. | get, getRaw, getWithMetadata, save, trySaveIfhashMatches |\n\n### `@vtex/api`\n\nThe [@vtex/api](https://read.calvincode.net/reader?url=https://github.com/vtex/node-vtex-api/blob/master/src/clients/IOClients.ts%23L15) package provides the following clients for IO apps using the `node` Builder:\n\n| Name | Description | Methods |\n| --------------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | Handles identity management and authentication. | getTemporaryToken, sendCodeToEmail, getEmailCodeAuthenticationToken, getPasswordAuthenticationToken |\n| licenseManager | Interacts with License Manager services. | getAccountData, getTopbarData, canAccessResource |\n| masterdata | Interacts with Master Data services. | getSchema, createOrUpdateSchema, getPublicSchema, getDocument, createDocument, createOrUpdateEntireDocument, createOrUpdatePartialDocument, updateEntireDocument, updatePartialDocument, searchDocuments, searchDocumentsWithPaginationInfo, scrollDocuments, deleteDocument |\n| messagesGraphQL | Handles internationalization messages. | translateV2, translate, translateWithDependencies, saveV2, userTranslations |\n| catalogGraphQL | Interacts with the catalog management system using GraphQL. | sku, category, brand, product |\n| paymentProvider | Interacts with payment service providers. | callback, inbound |\n\n## Developing Clients\n\nConsider developing your own clients if you require integration with other services not covered by VTEX native clients. Custom clients extend VTEX IO native Clients, leveraging caching and versioning functionalities.\n\n> Note that direct communication with APIs is generally discouraged in favor of implementing a dedicated Client.\n\nLearn how to create Clients of your own by accessing the [Developing Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients) guide.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-clients.md)\n\n[Calling Commerce APIs - Conclusion« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients//docs/guides/calling-commerce-apis-conclusion)[Developing custom ClientsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients//docs/guides/vtex-io-documentation-how-to-create-and-use-clients)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Understanding Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23understanding-clients)\n\n[Advantages of using Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23advantages-of-using-clients)\n\n[List of native Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23list-of-native-clients)\n\n[@vtex/clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23vtexclients)[@vtex/api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23vtexapi)\n\n[Developing Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23developing-clients)\n\nWas this helpful?\n\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-clients.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Understanding Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23understanding-clients)\n\n[Advantages of using Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23advantages-of-using-clients)\n\n[List of native Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23list-of-native-clients)\n\n[@vtex/clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23vtexclients)[@vtex/api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23vtexapi)\n\n[Developing Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23developing-clients)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d55265cd
|
[
{
"role": "system",
"content": "You are a VTEX 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 productname in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-productname/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-productname/docs/api-reference)\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-productname/docs/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-productname/docs/storefront-development)\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-productname/docs/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-productname/docs/troubleshooting)\n\n[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-productname/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/updates/release-notes)\n\nProduct Name\n\nThe `product-name` block is responsible for displaying a product name along with other information about the product, such as the **SKU** or **brand**.\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-name` 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-name\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `product-name` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"product-name\": { \n\n2\n\n \"props\": { \n\n3\n\n \"showSku\": true, \n\n4\n\n \"showBrandName\": true \n\n5\n\n } \n\n6\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| classes | CustomCSSClasses | Overrides default CSS handles. For further information, please refer to [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 | enum | Displays the product name (plainText) or the link to the product page (linkToProductPage). | plainText |\n| showBrandName | boolean | Displays the brand name. | false |\n| showProductReference | boolean | Displays the product reference code. | false |\n| showSku | boolean | Displays the SKU value. | false |\n| tag | string | Defines the HTML tag of the product container. Possible values are: div, h1, h2, h3. | div |\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| productBrand |\n| productNameBrandLoader |\n| productNameContainer |\n| productNameLoader |\n| productNameSkuLoader |\n| productReference |\n| productSku |\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-productname.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-productname/docs/guides/vtex-store-components-productname%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/guides/vtex-store-components-productname%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/guides/vtex-store-components-productname%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-productname.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-productname/docs/guides/vtex-store-components-productname%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/guides/vtex-store-components-productname%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/guides/vtex-store-components-productname%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_2347f726
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides how to keep attachments from original orders in subscriptions in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/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/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/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/how-to-keep-attachments-from-original-orders-in-subscriptions/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/how-to-keep-attachments-from-original-orders-in-subscriptions/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/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/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/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/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/how-to-keep-attachments-from-original-orders-in-subscriptions/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/how-to-keep-attachments-from-original-orders-in-subscriptions/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/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides)\n\nOrders\n\nSubscriptions\n\n[How to keep attachments from original orders in subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions)\n\nHow to keep attachments from original orders in subscriptions\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-subscriptions-work--frequentlyAskedQuestions%5F4453) is the VTEX solution for customers who want to make recurring purchases at the store on a regular schedule. When customers subscribe, they define what products they want to acquire regularly and at the frequency they want these automatic orders to be created.\n\nWhen a new subscription is created from an order containing SKUs with [attachments](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm), the platform default behavior is to discard the attachments in future subscription orders. However, you can configure the store to incorporate SKU attachments from the original order into recurring orders.\n\n## Configuring the store to keep attachments from original orders\n\nTo allow a VTEX store to keep SKU attachments for subscription orders, use the [Edit subscriptions settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/settings) endpoint. Within the request body, in the `attachmentPreferences` object, set the `enableAttachments` field as `true`, as shown below:\n\n`1\n\n\"attachmentPreferences\": { \n\n2\n\n \"enableAttachments\": true \n\n3\n\n } \n\n`\n\n> Whether an order contains the [same SKU with or without attachments](#original-orders-containing-the-same-skus-with-different-attachments), keep in mind that the platform's default behavior is to group these SKUs. You can configure the platform to [split the same SKUs with attachments](#configuring-to-split-the-same-skus-with-different-attachments) instead.\n\n## Original orders containing the same SKUs with different attachments\n\nThe platform’s default behavior when keeping attachments from original orders is to group the same SKUs, regardless of whether they have attachments.\n\nThe table below shows how the SKU grouping works:\n\n| **Original order** | **Subscription order grouping different attachments for the same SKU** | **Behavior** |\n| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| Total: 8 items\\[1\\] SKU X - Attachment A: Type IQuantity: 2\\[2\\] SKU X - Attachment A: Type IIQuantity: 3\\[3\\] SKU X - No attachmentQuantity: 1\\[4\\] SKU X - No attachmentQuantity: 1\\[5\\] SKU Y - No attachmentQuantity: 1 | Total: 8 items\\[1\\] SKU X - Attachment A: Type I + SKU X - Attachment A: Type II + SKU X - No attachmentQuantity: 7\\[2\\] SKU Y - No attachmentQuantity: 1 | When the original order has the same SKUs, with and without attachments, the subscription order groups them together. |\n\nYou can change this behavior so that subscription orders created from original orders containing the same SKUs with different attachments are not grouped together but kept separate.\n\nThe table below shows how that works:\n\n| **Original order** | **Subscription orders splitting the same SKUs with different attachments** | **Behavior** |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Total: 8 items\\[1\\] SKU X - Attachment A: Type IQuantity: 2\\[2\\] SKU X - Attachment A: Type IIQuantity: 3\\[3\\] SKU X - No attachmentQuantity: 1\\[4\\] SKU X - No attachmentQuantity: 1\\[5\\] SKU YQuantity: 1 | Total: 8 items\\[1\\] SKU X - Attachment A: Type IQuantity: 2\\[2\\] SKU X - Attachment A: Type IIQuantity: 3\\[3\\] SKU X - No attachmentQuantity: 2\\[4\\] SKU Y - No attachmentQuantity: 1 | The organization from the original order is kept for subscription orders, and the same SKUs with attachments are no longer grouped, not even if they have the same type of attachment. Only SKUs that do not have attachments will be grouped. |\n\n## Configuring to split the same SKUs with different attachments\n\nTo allow a VTEX store to keep SKU attachments for new subscriptions, use the [Edit subscriptions settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/settings) endpoint. In the request body, inside the property `attachmentPreferences`, set the `enableAttachments` field to `true`, as shown below:\n\n`1\n\n\"attachmentPreferences\": { \n\n2\n\n \"enableAttachments\": true, \n\n3\n\n \"splitSameSkuWithDifferentAttachments\": true \n\n4\n\n } \n\n`\n\n> The `splitSameSkuWithDifferentAttachments` field can only be set to `true` if the `enableAttachments` field is also set to `true`.\n\nContributors\n\n1\n\n[](https://github.com/Isabella-Veloso)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Subscriptions/how-to-keep-attachments-from-original-orders-in-subscriptions.md)\n\n[Enabling Manual Prices for Subscriptions v3« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions//docs/guides/enabling-manual-prices-for-subscriptions-v3)[VTEX Shipping NetworkNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions//docs/guides/vtex-shipping-network)\n\nContributors\n\n1\n\n[](https://github.com/Isabella-Veloso)\n\nON THIS PAGE\n\n[Configuring the store to keep attachments from original orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23configuring-the-store-to-keep-attachments-from-original-orders)\n\n[Original orders containing the same SKUs with different attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23original-orders-containing-the-same-skus-with-different-attachments)\n\n[Configuring to split the same SKUs with different attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23configuring-to-split-the-same-skus-with-different-attachments)\n\nWas this helpful?\n\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/how-to-keep-attachments-from-original-orders-in-subscriptions.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuring the store to keep attachments from original orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23configuring-the-store-to-keep-attachments-from-original-orders)\n\n[Original orders containing the same SKUs with different attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23original-orders-containing-the-same-skus-with-different-attachments)\n\n[Configuring to split the same SKUs with different attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23configuring-to-split-the-same-skus-with-different-attachments)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d74bbf83
|
[
{
"role": "system",
"content": "You are a VTEX 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 components index in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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/components-index/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/api-reference)\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/components-index/docs/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/components-index/docs/storefront-development)\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/components-index/docs/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/components-index/docs/troubleshooting)\n\n[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/components-index/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/components-index/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/components-index/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/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/components-index/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/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/components-index/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/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/components-index/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/components-index/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/components-index/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/components-index/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/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/components-index/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/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/components-index/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/components-index/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/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/components-index/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/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/components-index/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/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/components-index/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/components-index/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/components-index/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/components-index/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/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/components-index/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore)\n\nFastStore UI\n\nFastStore UI is designed and built following the [Atomic Design](https://read.calvincode.net/reader?url=https://bradfrost.com/blog/post/atomic-web-design/) pattern. Atomic Design breaks user interfaces hierarchically into smaller and simpler components, and the FastStore components are classified as **atoms**, **molecules**, **organisms**, and **features**.\n\n## [Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview)\n\n* [SuccessBadgeBadges are status descriptors used to emphasize an item's state.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-badge)\n* [PrimaryButtonButtons indicate actions that users can take, like adding an item to the cart.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-button)\n* [CheckboxCheckboxes allow users to toggle an option on or off.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-checkbox)\n* [IconIcons are simplified graphics used to represent concepts and help users navigate the UI.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-icon)\n* [InputFields used to get user inputs.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-input)\n* [LabelLabelDescribes the meaning of input fields.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-label)\n* Default \nLink \nPerforms the same behavior of a regular anchor tag (`a`), but can be used as any HTML tag and component.\n* [Great Unordered ListOk Unordered ListBad Unordered ListListLists group related content. They can be ordered or unordered.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-list)\n* [LoaderLoaders provide a visual cue that an action is being processed.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-loader)\n* [A content outside meOverlayOverlays provide contextual information on top of the current layer of the interface.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-overlay)\n* [62.5PriceUsed to display the price of a given product, discount and total values.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-price)\n* [RadioAllow users to select one option from a set.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-radio)\n* [GreatOkBadSelectSelect components allow users to pick an option from a predefined list.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-select)\n* [SkeletonImproves the store's experience and perceived performance through loading placeholders.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-skeleton)\n* [0500SliderAllows users to select a single value from a range.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-slider)\n* [visually hidden textSROnlyHides an element visually. Improve accessibility by providing text to screen readers when applied.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-sr-only)\n\n---\n\n## [Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview)\n\n* [ClothingShortsSweatshirtTank topsBagsBackpacksNecessaireSaleSmartphonesTVsAccordionDisplays an expandable/collapsible list of items.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-accordion)\n* [Alert message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-alert)[Link](#) \nAlert \nDisplays short messages related to the behavior of a system, feature or page.\n* [](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-breadcrumb)[Echo Dot Smart Speaker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/echo-dot-smart-speaker-99988214/p)\n* Oculus VR Headset\n\n 1. [Technology](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/technology/)\n 2. [Echo Dot Smart Speaker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/echo-dot-smart-speaker-99988214/p)\n 3. Oculus VR Headset\n\nBreadcrumb\n\nIndicates the user's location in a website hierarchy.\n\n* [Buy NowBuyButtonIntends to send the user to the checkout/cart step directly.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-buy-button)\n* [Card with Icon Message CardA card with a header and body, ideal for displaying products, messages, or store information.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-card)\n* [](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-carousel)Apple Magic Mouse \nOriginal price:$999Price:$950.04\n*  \n### 4k Philips Monitor 27” \nOriginal price:$490Price:$420\n*  \n### Echo Dot Smart Speaker \nOriginal price:$310Price:$280\n*  \n### Aedle VK-1 L Headphone \nOriginal price:$150Price:$130\n*  \n### Oculus VR Headset \nOriginal price:$344Price:$315\n*  \n### Apple AirPods Pro \nOriginal price:$249Price:$229\n*  \n### Anker SoundCore Liberty Air \nOriginal price:$643.71Price:$486.34\n*  \n### Fujifilm X-T1 Camera \nOriginal price:$495.97Price:$366.11\n*  \n### SANDMARC Fisheye Lens \nOriginal price:$946.73Price:$636.05\n*  \n### Apple AirTag \nOriginal price:$679.29Price:$426.14\n\nCarousel\n\nSlides through multiple elements using custom controls.\n\n* [Apple Magic MouseColor: BlackSize: MediumOriginal price:$999Price:$950.04CartItemUsed to present the summarized information of a product inside the Cart.](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-cart-item)\n* [DefaultCheckboxFieldWraps a Checkbox input and its corresponding Label. It allows users to select one option from a set.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-checkbox-field)\n* [50% offDiscountBadgeA custom Badge that display product's discounts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-discount-badge)\n* [DropdownDropdownDisplays a set of actions/items to the user, usually used to show a menu of options.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-dropdown)\n* [Get a Apple Magic MouseOriginal price:$999FreeGiftDisplays an additional item to purchase as a gift.](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-gift)\n* [IconButtonicons that trigger some sort of action, such as adding an item to the cart.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-icon-button)\n* [Input w/ ActionApplyInputFieldWraps an Input and its corresponding Label.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-input-field)\n* [Link Button](#) \nLinkButton \nVisuallly replicates a `Button`, however acts as a link to navigate users between pages.\n* [Open ModalModalAre dialog windows that sit on top of an application's main view.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-modal)\n* [Set location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-navbar-links)[Office](#)\n* [Home Appliances](#)\n* [Computer and Software](#)\n* [Technology](#)\n\nNavbarLinks\n\nUsed to display a set of navigation links that self adapts on mobile or desktop screens.\n\n* [Subtotal (3 products)$1,200Discount\\-$100Total$1,100OrderSummaryProvides a summary of the items in the cart, including the total price, related shipping tax, and discounts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-order-summary)\n* [Popover TriggerPopoverProvides contextual information related to a trigger element when a user interacts with it to open the container.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-popover)\n* [](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-product-card)Mouse \nOriginal price:$999Price:$950.04 \nProductCard \nDisplays summarized information about a product.\n* [Original price:$999Price:$950.04ProductPriceDisplays the product's listing and spot price.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/components/molecules/product-price)\n* [Apple Mouse10% offRef.: 99995945ProductTitleUsed on Product Details Page, wraps the product name, a product label and the rating.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-product-title)\n* [Quantity SelectorAllows customers to select the quantity of a given product to purchase.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-quantity-selector)\n* [CheckedRadio FieldWraps a Radio input and its corresponding Label. It allows users to select one option from a set.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-radio-field)\n* [FirstSecondThirdRadio GroupAllows users to select a single option from a list of two or more mutually exclusive options.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-radio-group)\n* [RatingDisplays the average rating of a product based on other shoppers' feedback and reviews.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-rating)\n* [Set your locationRegion BarTrigger the RegionModal and is part of Regionalization feature.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-region-bar)\n* [](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-search-auto-complete)[appl**e airpods**](#)\n* [appl**e tv**](#)\n\nSearch Auto Complete\n\nLists auto completing suggestions based on searched term. This component is part of the `Search` feature.\n\n* [](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-search-dropdown)[appl**e**](#)\n* [appl**e magic mouse**](#)\n\nSuggested Products\n\n1. [Apple Magic MouseOriginal price:$999Price:$950.04](#)\n2. [Apple Magic MouseOriginal price:$999Price:$950.04](#)\n\nSearch Dropdown\n\nCombines all `Search` components to show all options in `SearchInput`. This component is part of the `Search` feature.\n\n* [HistoryClear History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-search-history)[Headphone](#)\n* [Audio & Video](#)\n* [mh-7000](#)\n\nSearch History\n\nResponsible for showing the latest terms searched by a user. This component is part of the `Search` feature.\n\n* [Search Input FieldAn InputField with a search button. This component is part of the Search feature.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-search-input-field)\n* [Suggested Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-search-products)[Apple Magic MouseOriginal price:$999Price:$950.04](#)\n* [Apple Magic MouseOriginal price:$999Price:$950.04](#)\n\nSearch Products\n\nShows details of the suggested products. This component is part of the `Search` feature.\n\n* [Top Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-search-top)[1Notebooks](#)\n* [2Laser Printer](#)\n* [3Bluetooth Keyboard](#)\n\nSearch Top\n\nDisplays the most searched terms by customers. This component is part of the `Search` feature.\n\n* [Select a Status:GreatOkBadSelect FieldWraps a Select input and its corresponding Label. It allows users to select one option from a set.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-select-field)\n* [Color: **Blue**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-sku-selector)[Color: Blue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/tech-keyboard-99988216/p)\n* [Color: Yellow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/tech-keyboard-99988212/p)\n* [Color: Gray](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/tech-keyboard-99988210/p)\n\nSKU Selector\n\nUsed in Product Details Pages (PDPs) to display all the available variants for a given product.\n\n* [BorderedTotal1x$2002x$2003x$204TableDisplays information in a friendly way, allowing users to scan for details quickly.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-table)\n* [TagTagAre an interactive Badge. By default, its have a close button.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-tag)\n* [Simple ToastToastUsed to display notifications.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-toast)\n* [ToggleA customized checkbox input styled to look like a switch button.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-toggle)\n* [LabelToggle FieldToggle Field wraps a Toggle input and its corresponding Label.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/molecules-toggle-field)\n\n---\n\n## [Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-overview)\n\n* [Explore more about our amazing products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-banner-text)[See more](/) \nBanner Text \nUsed for advertising brands, products, and/or collections.\n* [Open CartCart SidebarDisplays the summary of items added to the cart along with detailed information, and checkout option.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-cart-sidebar)\n* [Your Cart is emptyStart ShoppingEmpty StateUsed to represent an empty state.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-empty-state)\n* [FiltersPriceCategoryBrandOpen FiltersFilterFilters products inside the Product Listing Page (PLP) and Search Page.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-filter)\n* [Open FiltersFilter SliderThe mobile Filter view that is rendered inside a SlideOver component.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-filter-slider)\n* [Explore our productsAll the amazing products from the brands we partner with.](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-hero)[See more](/) \nHero \nFull-width banner presented on the above-the-fold section of a web page.\n* [Image GalleryUsed when you want to display a series of photos in a gallery on a post or page.](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-image-gallery)\n* [Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-navbar)[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* [Open MenuNavbar SliderAs part of the Navbar, this component is its **mobile version** used to list the navigation links through the NavbarLinks.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-navbar-slider)\n* [Get News and Special Offers!Receive our news and promotions in advance. Enjoy and get 10% off your first purchase. For more information click here.NameEmailBy subscribing to our newsletter you agree to to our Privacy Policy.SubscribeNewsletterThe Newsletter component is a section that features a text input field and an action button, allowing users to subscribe to updates and newsletters.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-newsletter)\n* [Out of StockNotify me when availableEmailNotify MeOut of StockUsed to announce to users that the product is out of stock.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-out-of-stock)\n* [Payment MethodsAmexVisaDiners ClubMastercardElo CardPayPalPixStripeGooglePayApplePayPayment MethodsDisplays the logos of the available payment options in a store.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-payment-methods)\n* [$0$500$100$250MinMaxPrice RangeSlider that allows users to select a maximum and minimum price from a range.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-price-range)\n* [](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-product-grid)Apple Magic Mouse \nOriginal price:$999Price:$950.04\n*  \n### 4k Philips Monitor 27” \nOriginal price:$490Price:$420\n*  \n### Echo Dot Smart Speaker \nOriginal price:$310Price:$280\n*  \n### Aedle VK-1 L Headphone \nOriginal price:$150Price:$130\n*  \n### Oculus VR Headset \nOriginal price:$344Price:$315\n*  \n### Apple AirPods Pro \nOriginal price:$249Price:$229\n*  \n### Anker SoundCore Liberty Air \nOriginal price:$643.71Price:$486.34\n*  \n### Fujifilm X-T1 Camera \nOriginal price:$495.97Price:$366.11\n*  \n### SANDMARC Fisheye Lens \nOriginal price:$946.73Price:$636.05\n*  \n### Apple AirTag \nOriginal price:$679.29Price:$426.14\n\nProduct Grid\n\nA section generally used on PLP pages to list the products available in the store.\n\n* [](https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-product-shelf)Apple Magic Mouse \nOriginal price:$999Price:$950.04\n*  \n### 4k Philips Monitor 27” \nOriginal price:$490Price:$420\n*  \n### Echo Dot Smart Speaker \nOriginal price:$310Price:$280\n*  \n### Aedle VK-1 L Headphone \nOriginal price:$150Price:$130\n*  \n### Oculus VR Headset \nOriginal price:$344Price:$315\n*  \n### Apple AirPods Pro \nOriginal price:$249Price:$229\n\nProduct Shelf\n\nDisplays a list of products to be used as a section on the store.\n\n* [Open Region ModalRegion ModalA Modal with some region configurations. The component is part of Regionalization feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-region-modal)\n* [Search InputResponsible to receive, search and display suggestions. This component is part of the Search feature.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-search-input)\n* [ShippingPostal Code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-shipping-simulation)[I don't know my Postal Code](/) \nShipping Simulation \nLets customers set the `PostalCode` and see the shipping options in the `PDP`.\n* [RightSlide OverRepresents an aditional session that complements the screen's information.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/organisms-slide-over)\n\nContributors\n\n3\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/index.mdx)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/index.mdx)\n\n[Importing FastStore UI component styles« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/using-themes-importing-ui-components-styles)[AtomsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/atoms-overview)\n\nOn this page\n\nON THIS PAGE\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/components-index%23atoms)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/components-index%23molecules)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index/docs/guides/faststore/components-index%23organisms)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_6c25c2ab
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX apps vtexbr.kitlook app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/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/vtexbr.kitlook/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/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/vtexbr.kitlook/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/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/vtexbr.kitlook/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/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/vtexbr.kitlook/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/guides/advanced-components)\n\nKit Look\n\nCommunity extension\n\nVersion: 5.6.4\n\nLatest version: 5.6.4\n\n## ⚠️ Maintenance ⚠️\n\n_Starting June 1st 2023, this application will no longer be maintained by VTEX._\n\n---\n\nThe Kit Look app displays relevant products to the shopper at the time of purchase, increasing the store's product selling.\n\nThe customer can choose the items from the kit they want to buy or add the complete kit to the cart if they are interested in the combinations highlighted automatically by the store.\n\n\n\nIn the following sections, learn how to add the app to your store and configure it.\n\n## Before you start\n\nSet up the Kit with all the products that will be displayed. To do so, refer to the tutorial [Kit registration](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/kit-registration--tutorials%5F215).\n\n## Step-by-step\n\n### Step 1 - Installing the app\n\n1. Go to the [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtexbr-kitlook/p) and after logging into your account, click on `GET APP`.\n2. You will be redirected to the checkout and choose a payment method since **the Kit Look is a paid app.**\n\n> As the Kit look is a paid app, you will be charged a US$0.01 fee to validate your credit card information. This will be refunded as soon as the payment is approved.\n\nOnce you have paid for the app, it is installed in your account.\n\n1. To finish this step, import it in your store's `peerDependencies` in `manifest.json`.\n\n`1\n\n{ \n\n2\n\n \"peerDependencies\": { \n\n3\n\n \"vtexbr.kitlook\": \"5.x\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\n### Step 2 - Configuration\n\nThe Kit Look order by default is sorted by the productId in ascending order, but it is possible to configure it to respect the Kit order registration through the settings in the Kit Look app inside my applications.\n\nFurthermore it is possible to select which components the kitlook block should render. The default configuration is shown in the image:\n\n\n\nThe `kitlook-layout` interface works by alternating the blocks if it detects that the product is a kit.\n\nTherefore, you have to add its interface in your app store theme code. There are two ways to achieve this: Adding the `kitlook-layout` interface in the `interfaces.json` or `product.jsonc`.\n\nCheck out the following sections to add the `kitlook-layout` interface.\n\n### Adding `kitlook-layout` in the `interfaces.json`\n\n1. Allow the Kit look interfaces by adding the Kit Look in the `store.product` in `interfaces.json` of your app theme.\n\n`1\n\n// interfaces.json \n\n2\n\n{ \n\n3\n\n \"store.product.kitlook\": { \n\n4\n\n \"allowed\": [\"kitlook-layout\", \"kitlook\"] \n\n5\n\n } \n\n6\n\n} \n\n`\n\n1. Then, add the `kit look-layout` interface to the page you want to display a different block when the product is a kit.\n\n`1\n\n// product.json \n\n2\n\n{ \n\n3\n\n \"store.product.kitlook\": { \n\n4\n\n \"children\": [ \n\n5\n\n \"flex-layout.row#product-breadcrumb\", \n\n6\n\n \"kitlook-layout\", // <--- Here's our new block \n\n7\n\n \"flex-layout.row#description\", \n\n8\n\n \"shelf.relatedProducts\" \n\n9\n\n ] \n\n10\n\n }, \n\n11\n\n \"kitlook-layout\": { \n\n12\n\n \"children\": [ \n\n13\n\n \"flex-layout.row#product-main\", // <--- The first child is for regular product \n\n14\n\n \"flex-layout.row#kitlook\" // <--- The second one will show when a product is a kit \n\n15\n\n ] \n\n16\n\n } \n\n17\n\n} \n\n`\n\n> Keep in mind that the first block specified will always be for regular products, and the second one is for your custom product page that you want to display if the product is a kit.\n\n1. In your second block, you can use the `kitlook` block to display the kit items. For example:\n\n`1\n\n// product.json \n\n2\n\n{ \n\n3\n\n \"flex-layout.row#kitlook\": { \n\n4\n\n \"props\": { \n\n5\n\n \"colGap\": 7, \n\n6\n\n \"rowGap\": 7, \n\n7\n\n \"marginTop\": 4, \n\n8\n\n \"marginBottom\": 7, \n\n9\n\n \"paddingTop\": 7, \n\n10\n\n \"paddingBottom\": 7 \n\n11\n\n }, \n\n12\n\n \"children\": [\"flex-layout.col#kitlook\", \"flex-layout.col#stack\"] \n\n13\n\n }, \n\n14\n\n \"flex-layout.col#kitlook\": { \n\n15\n\n \"props\": { \n\n16\n\n \"colGap\": 7, \n\n17\n\n \"rowGap\": 7, \n\n18\n\n \"marginTop\": 4, \n\n19\n\n \"marginBottom\": 7, \n\n20\n\n \"paddingTop\": 7, \n\n21\n\n \"paddingBottom\": 7 \n\n22\n\n }, \n\n23\n\n \"children\": [\"kitlook\"] \n\n24\n\n } \n\n25\n\n} \n\n`\n\nIn the example above, we are reusing the `flex-layout.col#stack` block shared with your regular product blocks.\n\n### Adding `kitlook-layout` in the `product.jsonc`\n\n1. Add `product-details.kitlook` as a child in your `store.product` in `store/blocks/product.jsonc`.\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#product-breadcrumb\", \n\n5\n\n \"product-details.kitlook\", \n\n6\n\n \"shelf.relatedProducts\", \n\n7\n\n \"product-reviews\", \n\n8\n\n \"product-questions-and-answers\" \n\n9\n\n ] \n\n10\n\n }, \n\n11\n\n ... \n\n12\n\n} \n\n`\n\n1. In your `product-details.kitlook` add `kitlook` as a block.\n\n`1\n\n{ \n\n2\n\n \"product-details.kitlook\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"kitlook\", \n\n5\n\n \"product-images\", \n\n6\n\n \"product-description\", \n\n7\n\n \"product-specifications\", \n\n8\n\n \"buy-button\", \n\n9\n\n \"sku-selector\", \n\n10\n\n \"shipping-simulator\", \n\n11\n\n \"product-highlights\", \n\n12\n\n \"availability-subscriber\", \n\n13\n\n \"product-price\", \n\n14\n\n \"product-name\", \n\n15\n\n \"share#default\" \n\n16\n\n ], \n\n17\n\n \"props\": { \n\n18\n\n \"displayVertically\": true \n\n19\n\n } \n\n20\n\n } \n\n21\n\n} \n\n`\n\n## Customization\n\nIn order to apply CSS customizations in the kitlook block, 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| kitlookContainer |\n| kitlookBox |\n| kitlookImage |\n| kitlookDetails |\n| kitlookName |\n| kitlookDescription |\n| kitlookPrice |\n| kitlookButton |\n| kitlookCheckbox |\n\n### Product Summary\n\nIf you have any shelves which may display kits you need to replace the `product-summary` or `product-summary.shelf` interface with `product-summary.kitlook-layout` in those shelves in `store/blocks/home/home.jsonc`\n\n`1\n\n{ \n\n2\n\n \"shelf#home\": { \n\n3\n\n \"blocks\": [\"product-summary.kitlook-layout\"], \n\n4\n\n \"props\": { \n\n5\n\n \"orderBy\": \"OrderByTopSaleDESC\", \n\n6\n\n \"paginationDotsVisibility\": \"desktopOnly\", \n\n7\n\n \"skusFilter\": \"FIRST_AVAILABLE\", \n\n8\n\n \"productList\": { \n\n9\n\n \"maxItems\": 10, \n\n10\n\n \"itemsPerPage\": 5, \n\n11\n\n \"minItemsPerPage\": 1.5, \n\n12\n\n \"scroll\": \"BY_PAGE\", \n\n13\n\n \"arrows\": true, \n\n14\n\n \"titleText\": \"Top sellers\" \n\n15\n\n } \n\n16\n\n } \n\n17\n\n } \n\n18\n\n} \n\n`\n\n> We recommend you do the same for your `gallery` block, so the new layout is used in search results and categories pages.\n\n`1\n\n{ \n\n2\n\n \"gallery\": { \n\n3\n\n \"blocks\": [\"product-summary.kitlook-layout\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\nNow that you're using `product-summary.kitlook-layout`, you may want to specify a custom block for your regular products and another for kitlook, so let's do that.\n\nTo do that, somewhere in your `blocks.json` add the block `product-summary.kitlook-layout`.\n\nYou can specify two children's blocks. The first will be displayed for regular products and the second for kitlooks.\n\n`1\n\n{ \n\n2\n\n \"product-summary.kitlook-layout\": { \n\n3\n\n \"children\": [\"product-summary.shelf\", \"product-summary.kitlook\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\n### Advanced\n\nBy default `product-summary.kitlook` displays a list with the name and price of the items in the kit.\n\nHowever, it is possible to achieve a wide range of customizations using `product-summary-kitlook` ( different from the `product-summary.kitlook`)\n\nYou can specify any interface that a regular `product-summary` accepts, e.g., `product-summary-image`, `product-summary-buy-button`, to name a few.\n\nYou can also use `flex-layout` and `stack-layout` to achieve the maximum level of control.\n\nTake a look at how to do that.\n\n1. Create a new custom `product-summary.kitlook` so you can modify `product-summary-kitlook` and `product-summary-buy-button#kitlook` later on. For example:\n\n`1\n\n{ \n\n2\n\n \"product-summary.kitlook#custom\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"product-summary-image\", \n\n5\n\n \"product-summary-name\", \n\n6\n\n \"product-summary-space\", \n\n7\n\n \"product-summary-kitlook\", \n\n8\n\n \"product-summary-buy-button#kitlook\" \n\n9\n\n ] \n\n10\n\n } \n\n11\n\n} \n\n`\n\n1. Then, create a `flex-layout.row` and `flex-layout.col` columns to go inside it. In one column put the product image using `product-summary-image` and in the other `product-summary-name` and `product-summary-price`.\n\n`1\n\n{ \n\n2\n\n \"product-summary-kitlook\": { \n\n3\n\n \"children\": [\"flex-layout.row#product-summary-kitlook\"] \n\n4\n\n }, \n\n5\n\n \"flex-layout.row#product-summary-kitlook\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"flex-layout.col#kit-item-image\", \n\n8\n\n \"flex-layout.col#mini-summary\" \n\n9\n\n ], \n\n10\n\n \"props\": { \n\n11\n\n \"colGap\": 3, \n\n12\n\n \"border\": [\"top\"], \n\n13\n\n \"borderWidth\": 1, \n\n14\n\n \"borderColor\": \"silver\", \n\n15\n\n \"paddingTop\": 5 \n\n16\n\n } \n\n17\n\n }, \n\n18\n\n \"flex-layout.col#kit-item-image\": { \n\n19\n\n \"children\": [\"product-summary-image\"], \n\n20\n\n \"props\": { \n\n21\n\n \"width\": \"33%\" \n\n22\n\n } \n\n23\n\n }, \n\n24\n\n \"flex-layout.col#mini-summary\": { \n\n25\n\n \"children\": [\"product-summary-name\", \"product-summary-price#mini\"], \n\n26\n\n \"props\": { \n\n27\n\n \"horizontalAlign\": \"left\" \n\n28\n\n } \n\n29\n\n }, \n\n30\n\n \"product-summary-price#mini\": { \n\n31\n\n \"props\": { \n\n32\n\n \"showLabels\": false, \n\n33\n\n \"showInstallments\": false, \n\n34\n\n \"showListPrice\": false \n\n35\n\n } \n\n36\n\n } \n\n37\n\n} \n\n`\n\nEverything put together:\n\n`1\n\n{ \n\n2\n\n \"product-summary.kitlook-layout\": { \n\n3\n\n \"children\": [\"product-summary.shelf\", \"product-summary.kitlook#custom\"] \n\n4\n\n }, \n\n5\n\n \"product-summary.kitlook#custom\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"product-summary-image\", \n\n8\n\n \"product-summary-name\", \n\n9\n\n \"product-summary-space\", \n\n10\n\n \"product-summary-kitlook\", \n\n11\n\n \"product-summary-buy-button#kitlook\" \n\n12\n\n ] \n\n13\n\n }, \n\n14\n\n \"product-summary-kitlook\": { \n\n15\n\n \"children\": [\"flex-layout.row#product-summary-kitlook\"] \n\n16\n\n }, \n\n17\n\n \"flex-layout.row#product-summary-kitlook\": { \n\n18\n\n \"children\": [ \n\n19\n\n \"flex-layout.col#kit-item-image\", \n\n20\n\n \"flex-layout.col#mini-summary\" \n\n21\n\n ], \n\n22\n\n \"props\": { \n\n23\n\n \"colGap\": 3, \n\n24\n\n \"border\": [\"top\"], \n\n25\n\n \"borderWidth\": 1, \n\n26\n\n \"borderColor\": \"silver\", \n\n27\n\n \"paddingTop\": 5 \n\n28\n\n } \n\n29\n\n }, \n\n30\n\n \"flex-layout.col#kit-item-image\": { \n\n31\n\n \"children\": [\"product-summary-image\"], \n\n32\n\n \"props\": { \n\n33\n\n \"width\": \"33%\" \n\n34\n\n } \n\n35\n\n }, \n\n36\n\n \"flex-layout.col#mini-summary\": { \n\n37\n\n \"children\": [\"product-summary-name\", \"product-summary-price#mini\"], \n\n38\n\n \"props\": { \n\n39\n\n \"horizontalAlign\": \"left\" \n\n40\n\n } \n\n41\n\n }, \n\n42\n\n \"product-summary-price#mini\": { \n\n43\n\n \"props\": { \n\n44\n\n \"showLabels\": false, \n\n45\n\n \"showInstallments\": false, \n\n46\n\n \"showListPrice\": false \n\n47\n\n } \n\n48\n\n }, \n\n49\n\n \"product-summary-buy-button#kitlook\": { \n\n50\n\n \"props\": { \n\n51\n\n \"buyButtonBehavior\": \"alwaysGoToProduct\" \n\n52\n\n } \n\n53\n\n } \n\n54\n\n} \n\n`\n\nAfter that, do not forget to change the default product page interface on **CMS > Pages** to use the `store.product.kitlook interface`.\n\nYou can expect to have a similar result as the following:\n\n\n\n[Category Menu« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.category-menu)[Icon Pack listNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtex.store-icons/iconpack)\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/vtexbr.kitlook/docs/apps/vtexbr.kitlook%23-maintenance-)\n\n[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook%23before-you-start)\n\n[Step-by-step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook%23step-by-step)\n\n[Step 1 - Installing the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook%23step-1-installing-the-app)[Step 2 - Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook%23step-2-configuration)[Adding kitlook-layout in the interfaces.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook%23adding-kitlook-layout-in-the-interfacesjson)[Adding kitlook-layout in the product.jsonc](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook%23adding-kitlook-layout-in-the-productjsonc)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook%23customization)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook%23product-summary)[Advanced](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.kitlook/docs/apps/vtexbr.kitlook%23advanced)\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_f5ca20ca
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides customize checkout confirmation pages in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/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/customize-checkout-confirmation-pages/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customization)\n\n[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/checkout-customization-guide)\n\n[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customize-checkout-confirmation-pages)\n\n[Change payment method names in Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/change-payment-method-names-in-checkout)\n\n[Enable an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/enable-an-observation-field-on-the-checkout-page)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/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/customize-checkout-confirmation-pages/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/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/customize-checkout-confirmation-pages/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/customize-checkout-confirmation-pages/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/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/customize-checkout-confirmation-pages/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customization)\n\n[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/checkout-customization-guide)\n\n[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customize-checkout-confirmation-pages)\n\n[Change payment method names in Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/change-payment-method-names-in-checkout)\n\n[Enable an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/enable-an-observation-field-on-the-checkout-page)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/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/customize-checkout-confirmation-pages/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/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/customize-checkout-confirmation-pages/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/customize-checkout-confirmation-pages/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/checkout-api-overview)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customization)\n\n[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customize-checkout-confirmation-pages)\n\nCustomize checkout confirmation pages\n\nAll order confirmation information at checkout is available on the Placed Orders and Order Confirmation pages. If the merchant wants to change some features on these UIs, VTEX also offers the option of customizing them.\n\nOrder Placed page example:\n\n\n\nIn the Checkout section, located in the Admin VTEX side menu, you can access one or more websites (stores) registered in your account and perform checkout settings, including UI customization.\n\nBy clicking on the `blue gear` button of the chosen website, and selecting the **Code** tab, you will have access to a list of files and templates, where you can edit or import the HTML information.\n\n> The same files shown in the Code tab are publicly available in the route `https://{accountName}.myvtex.com/files/`.\n\n## Edit Information\n\nTo edit Checkout confirmation UI information, access the following templates:\n\n* **checkout-confirmation-bottom**\n* **checkout-confirmation-footer**\n* **checkout-confirmation-header**\n* **checkout-confirmation-top**\n\nCode tab view:\n\n\n\n> It is important to note that any customization performed on the templates will be applied to both pages at the same time (Order Placed and Order Confirmation).\n\nTemplate areas on the page:\n\n\n\n## Customizing styles\n\nYou can also edit the Checkout Confirmation interface via CSS classes. Your styles should be added in a `<stile>` tag in one of the HTML templates loaded on the page.\n\nCSS class areas on the page:\n\n\n\nTo customize the Checkout Confirmation styles, use the following classes:\n\n`1\n\n.cconf-alert // Confirmation alert \n\n2\n\n.cconf-client-email // Element that carries customer's email \n\n3\n\n.cconf-address // Card with order address \n\n4\n\n.cconf-payment // Card with payment method \n\n5\n\n.cconf-summary // Card with order summary \n\n6\n\n.cconf-product-table // Table with product's orders \n\n7\n\n.cconf-product // Table's line with order \n\n8\n\n.cconf-continue-button // Button leading back to the store \n\n`\n\n## JS customization\n\nThe page may also be changed through Javascript using the files **checkout-confirmation-custom.js** or **checkout-confirmation-custom4.js** (depending on the version of Checkout confirmation you are using, v3 or v4), which can be accessed by selecting the **Code** tab at the Admin.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/customization/customize-checkout-confirmation-pages.md)\n\n[Checkout customization guide« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages//docs/guides/checkout-customization-guide)[Change payment method names in CheckoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages//docs/guides/change-payment-method-names-in-checkout)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Edit Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customize-checkout-confirmation-pages%23edit-information)\n\n[Customizing styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customize-checkout-confirmation-pages%23customizing-styles)\n\n[JS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customize-checkout-confirmation-pages%23js-customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/customization/customize-checkout-confirmation-pages.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Edit Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customize-checkout-confirmation-pages%23edit-information)\n\n[Customizing styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customize-checkout-confirmation-pages%23customizing-styles)\n\n[JS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages/docs/guides/customize-checkout-confirmation-pages%23js-customization)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_51883b30
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore troubleshooting overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-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/troubleshooting-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/troubleshooting-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/troubleshooting-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/troubleshooting-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/troubleshooting-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/troubleshooting-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/troubleshooting-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-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/troubleshooting-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/troubleshooting-overview)\n\n[Debugging Partytown and analytics issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/troubleshooting-analytics-and-partytown)\n\n[Identifying development errors and Starter bugs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs)\n\n[Tracing the error source](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/troubleshooting-tracing-the-error-source)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-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/troubleshooting-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-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/troubleshooting-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/troubleshooting-overview)\n\n[Debugging Partytown and analytics issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/troubleshooting-analytics-and-partytown)\n\n[Identifying development errors and Starter bugs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs)\n\n[Tracing the error source](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/troubleshooting-tracing-the-error-source)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-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/troubleshooting-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/troubleshooting-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore)\n\nTroubleshooting\n\nEcommerce websites are comprised of complex solutions with multiple scripts and APIs. That's why debugging such a system may sometimes be challenging. Hence, to help you pinpoint the exact origin of the errors you may be facing, we've developed general guidelines you can use to troubleshoot these issues.\n\nThe first thing to note is that there are three primary sources of errors on FastStore projects:\n\n* **Starter bugs** \\- issues present on the Starter. These bugs are forked from the Starter project and replicated on your project even before you begin writing your own code.\n* **Ecommerce provider API bugs** \\- issues related to your ecommerce provider API. For instance, the API returns data in the wrong order.\n* **Customization bugs** issues introduced during development.\n\nThus, to begin debugging your project, we recommend using the approach outlined below:\n\n\n\n**Check if the bug you are facing is a Starter bug**. Please refer to the [Identifying development errors and Starter bugs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs) guide for more information.\n\nIf you detect that you are facing a Starter bug, report the problem by opening an issue at the Starter repository. Otherwise, **test if the API requests from your ecommerce provider are working as expected**. For instance, VTEX has a [list of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/getting-started-list-of-rest-apis) where you can test if the request responses are as expected.\n\nIf you check the problem is not related to your ecommerce provider APIs, consider that the issue may be related to your own code. In this case, if your feature was working properly in the past, **use binary search to detect when, in time, the bug was introduced**. For more information, please refer to the [Tracing the error source](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-tracing-the-error-source) guide.\n\nFinally, if this is a new issue and you are not sure your feature was working before, check [React docs](https://read.calvincode.net/reader?url=https://reactjs.org/docs/design-principles.html%23debugging) to continue debugging your project. Also, consider checking [Next.js troubleshooting guides](https://read.calvincode.net/reader?url=https://nextjs.org/docs/advanced-features/debugging).\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/troubleshooting/overview.mdx)\n\n[4\\. Integrating the VTEX Order Placed and My Account« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)[Debugging Partytown and analytics issuesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-overview/docs/guides/faststore/troubleshooting-analytics-and-partytown)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/troubleshooting/overview.mdx)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_9f8a1bea
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting i cant create a new workspace in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/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/i-cant-create-a-new-workspace/docs/troubleshooting)\n\nDevelopment\n\nI can't create a new workspace\n\nNew workspaces can only be created if the Intelligent Search integration is enabled.\n\n**Keywords:** Workspace | Intelligent Search\n\nIf you can't [create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-usage%23creating-a-new-workspace), you might be getting the following error:\n\n`1\n\nRender fail when sender is vtex.menu. Request failed with status code 400. \n\n`\n\nThis issue is related to the Intelligent Search integration. To solve it, follow the instructions below.\n\n1. Access the Admin and go to **Store Settings** \\> **Intelligent Search** \\> **Integrations**.\n2. Check if the search has been activated in the store.\n3. Click the `Start integration` button to start the integration.\n\nThe indexing process will start and you will see a link to the Indexing Status screen.\n\n> The [Integrations page](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/6wKQgKmu2FT6084BJT7z5V) runs the initial Catalog indexing with VTEX Intelligent Search. After installing the application, this will be the first step for integrating it with Catalog.\n\n\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/i-cant-create-a-new-workspace.md)\n\n[vtex release CLI command returns an EBADF message« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)[I can't install an app with a major other than 0.xNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-create-a-new-workspace/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-create-a-new-workspace.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_5bd72837
|
[
{
"role": "system",
"content": "You are a VTEX 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 features delivery promise in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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/features-delivery-promise/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/api-reference)\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/features-delivery-promise/docs/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/features-delivery-promise/docs/storefront-development)\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/features-delivery-promise/docs/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/features-delivery-promise/docs/troubleshooting)\n\n[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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore/delivery-promise-implementation)\n\n[Understanding Delivery Promise operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview)\n\n[Working with Delivery Promise components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-components)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore/delivery-promise-implementation)\n\n[Understanding Delivery Promise operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview)\n\n[Working with Delivery Promise components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-components)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/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/features-delivery-promise/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/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/features-delivery-promise/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/storefront-features-overview)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-implementation)\n\nUnderstanding Delivery Promise operation\n\n> This feature is in closed beta, meaning only selected customers can access it. If you're interested in implementing it, please contact our [Support](https://read.calvincode.net/reader?url=https://support.vtex.com/hc/en-us) team.\n\nThis guide explains how Delivery Promise operates, covering the following:\n\n* [Hooks](#hooks): Discover the hooks used to manage user location, fulfillment options, and Delivery Promise workflows.\n* [Filter options](#filter-options): Learn how shoppers can filter products by delivery or pickup methods.\n* [Location priority](#location-priority): Understand the order and logic used to determine the shopper's location for accurate delivery estimates.\n\n> To learn how to implement Delivery Promise in your store, see the guide [Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation).\n\n## Hooks\n\nThis feature introduces the following hooks as part of the regionalization and location workflow:\n\n* `useGeoLocation`: Uses the browser's geolocation API or other client-side methods to auto-detect the user's location when not provided.\n* `useRegion`: Accesses or updates the user's region information, such as a postal code or location and manages region validation flows.\n* `useRegionModal`: Handles modal display logic for region selection, especially when the location input is mandatory.\n* [useDeliveryPromise\\_unstable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components%23list-of-hooks-and-components): Manages all logic for querying, displaying, and updating delivery availability filters and states.\n* [deliveryPromiseStore\\_unstable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components%23list-of-hooks-and-components): Stores and retrieves Delivery Promise data (pickup points, default/global selection, simulation state).\n\n## Filter options\n\nDelivery Promise offers shoppers two product filtering options:\n\n* [Global filters](#global-filters): Apply to all store navigation.\n* [Product List Page (PLP) or search page](#plp-or-search-page-filters): Apply only to the current page the shopper is viewing.\n\n> Learn more about filter usage and user flows on the [Delivery Promise Figma Community](https://read.calvincode.net/reader?url=https://www.figma.com/community/file/1545494767147168145/delivery-promise-by-vtex) page.\n\n### Global filters\n\nGlobal filters remain active across all user navigation and are applied to all product searches until they are changed or cleared.\n\nShoppers can filter available products globally using the **Filter by store** option, which displays only products available for pickup at a specific store. This filter shows all available pickup points within a 50-km radius, as configured in Checkout. The number of pickup points displayed is unlimited.\n\n\n\n### PLP or search page filters\n\nOn PLPs or search pages, shoppers have the following options for applying filters: [Delivery Methods](#delivery-methods-filters), [Delivery Option](#delivery-option-filters), and [Availability](#availability).\n\n> To edit the filter labels, follow the instructions in [Managing filters and badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation).\n\n#### Delivery Methods\n\nThis filter displays available products according to the shopper's location, allowing them to filter using the following options:\n\n\n\n| **Filter option** | **Description** |\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **All delivery methods** | Displays products that match all active delivery method filters: **Shipping to**, **Pickup anywhere**, **Pickup at**, and **Pickup nearby**. |\n| **Shipping to** | Displays products that can be shipped to the shopper's specified location. |\n| **Pickup anywhere** | Displays products available for pickup at any participating store within the merchant's network, rather than restricting results to a selected pickup location or geographic proximity. This is often used by B2B stores, and this filter is deactivated in Headless CMS by default. |\n| **Pickup at** | Displays the store specified in the global pickup point filter or the one closest to the shopper's location. To change the store set in Pickup at {storeName}, the shopper can click on it and select a new store in the slideover that opens. This slideover shows all available pickup points within a 50-km radius, as configured in Checkout. |\n| **Pickup nearby** | Displays products available for pickup at the shopper's nearby stores. This filter considers up to 40 pickup points within 10 km of the shopper's location. |\n\n#### Delivery Option\n\nThis filter allows shoppers to refine search results based on the type of delivery or pickup method available for each item, helping to find products that match the shopper's preferred fulfillment method.\n\n\n\nTo create, configure, and manage delivery options in the VTEX Admin, see the instructions in the [Delivery Option (Beta)](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/docs/tutorials/delivery-options-beta) guide.\n\n> While following the instructions to [create the delivery options](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/docs/tutorials/delivery-options-beta%23creating-delivery-options), make sure to enable the option **Use option as a filter on the store product**. This will allow shoppers to filter products by the delivery option using [Intelligent Search filters](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/en/tutorial/filters--k24mQQa9SjmhNWSwdqIMB).\n\n#### Availability (In-stock filter)\n\nThis filter helps shoppers refine product results based on whether items are available for purchase and fulfillment, preventing the display of products they can't immediately buy in their preferred fulfillment method and narrowing results to only what’s actually in stock.\n\n\n\nThe Availability filter is disabled by default in the Headless CMS. This filter is helpful for stores where the `discovery.config.js` file has `hideUnavailableItems` set to `false`. Otherwise, when this setting is `true`, unavailable products are already hidden by default, so the Availability filter would have no functionality in this scenario.\n\nTo enable this filter in your store, follow the instructions in [Enabling the Availability filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation%23enabling-the-availability-filter).\n\n## Badges\n\nWhen Delivery Promise data is available, the `ProductCard` automatically displays badges so shoppers can quickly see shipping and pickup availability for their location.\n\n> An error occurred while loading the image https://vtexhelp.vtexassets.com/assets/docs/src/dp-badges\\_\\_\\_4b6a40b957e4eb45da5a854e676dce77.png\n\nIn the following table, see the available types of badges:\n\n| Badge label | Description |\n| -------------------------------------------------- | -------------------------------------------------------------------------- |\n| Available for shipping or Unavailable for shipping | Indicates whether the product can be shipped to the shopper's postal code. |\n| Available for pickup or Unavailable for pickup | Indicates that the product can be collected from a nearby pickup point. |\n| No badges available | The product is out of stock. Delivery and pickup are unavailable. |\n\n> To edit the badge labels or disable the badges, follow the instructions in [Managing filters and badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation).\n\n## Understanding location priority\n\nTo provide accurate Delivery Promise estimates, FastStore projects determine the user's location based on the following priority:\n\n1. **Logged-in user's address:** If the user is logged in and has a saved address, this information is used.\n2. **User-provided location:** If the user is logged in but doesn't have a saved address, or isn't logged in but provides their location (like a postal code), this data is used.\n3. **Default postal code:** If the user hasn't provided a location, isn't logged in, or has no saved address, we check if the merchant has configured a default postal code for all buyers. Learn how to do so in [Defining a default postal code](#step-4-optional-defining-a-default-postal-code).\n4. **No postal code (optional):** If no postal code is provided and not required, products are displayed without using Delivery Promise.\n5. **No postal code (required):** If no postal code is provided when required, a modal is displayed that the buyer cannot close until a postal code is entered. To make the postal code required, open your `discovery.config.js` file and change the `mandatory` field in the `deliveryPromise` object to `true`, as shown in the [Default settings](#default-settings) section.\n\nTo better understand how this flow works, see the following diagram:\n\nYes\n\nNo\n\nYes\n\nNo\n\nYes\n\nNo\n\nYes\n\nNo\n\nYes\n\nNo\n\nIs the user logged in?\n\nLogged-in user's address available?\n\nLocation provided?\n\nUse the logged-in user's address\n\nUse the provided location\n\nDefault postal code configured?\n\nUse the default postal code\n\nPostal code mandatory?\n\nDisplay mandatory postal code modal\n\nUser inputs postal code\n\nUse the provided postal code\n\nDisplay products without using Delivery Promise\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/features/delivery-promise/overview.mdx)\n\n[Implementing Delivery Promise« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-implementation)[Working with Delivery Promise componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-components)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Hooks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23hooks)\n\n[Filter options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23filter-options)\n\n[Global filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23global-filters)[PLP or search page filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23plp-or-search-page-filters)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23badges)\n\n[Understanding location priority](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23understanding-location-priority)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/features/delivery-promise/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Hooks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23hooks)\n\n[Filter options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23filter-options)\n\n[Global filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23global-filters)[PLP or search page filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23plp-or-search-page-filters)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23badges)\n\n[Understanding location priority](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise/docs/guides/faststore/delivery-promise-overview%23understanding-location-priority)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_49b52c04
|
[
{
"role": "system",
"content": "You are a VTEX 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 menu in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-menu/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/api-reference)\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-menu/docs/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-menu/docs/storefront-development)\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-menu/docs/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-menu/docs/troubleshooting)\n\n[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-menu/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/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-menu/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/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-menu/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-menu/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/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-menu/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-menu/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/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-menu/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/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-menu/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-menu/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/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-menu/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-menu/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-menu/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/guides/basic-components)\n\nMenu\n\nOfficial extension\n\nVersion: 2.35.3\n\nLatest version: 2.35.3\n\n[](#contributors)\n\nThe Menu component displays a navigation bar with links and dropdown submenus. It can be configured to display internal or external links and supports both category-based and custom menu items.\n\n\n\n## Configuration\n\n1. Add the app to the store theme dependencies in the `manifest.json` file.\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.menu\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `vtex.menu@2.x:menu` block to the [store header](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-header/blob/master/store/interfaces.json) template.\n2. Configure the `menu-item` blocks to build the store menu options. These can be declared in two ways in `vtex.menu@2.x:menu`: as children or as props. The advantage of the second type of `menu-item` configuration is that Site Editor can be used to edit the blocks.\n\n### `menu-item` as children\n\n_Example:_\n\n`1\n\n\"vtex.menu@2.x:menu#websites\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"menu-item#shop\", \n\n4\n\n \"menu-item#about-us\" \n\n5\n\n ] \n\n6\n\n}, \n\n7\n\n\"menu-item#shop\": { \n\n8\n\n \"props\": { \n\n9\n\n \"id\": \"menu-item-shop\", \n\n10\n\n \"type\": \"custom\", \n\n11\n\n \"highlight\": false, \n\n12\n\n \"itemProps\": { \n\n13\n\n \"type\": \"internal\", \n\n14\n\n \"href\": \"#\", \n\n15\n\n \"noFollow\": false, \n\n16\n\n \"tagTitle\": \"Shop\", \n\n17\n\n \"text\": \"Shop\" \n\n18\n\n }, \n\n19\n\n \"iconProps\": { \n\n20\n\n \"id\": \"bnd-logo\", \n\n21\n\n \"size\": 16, \n\n22\n\n \"viewBox\": \"0 0 16 16\", \n\n23\n\n \"activeClassName\": \"rebel-pink\", \n\n24\n\n \"mutedClassName\": \"c-action-primary\" \n\n25\n\n }, \n\n26\n\n \"iconToTheRight\": true \n\n27\n\n } \n\n28\n\n} \n\n`\n\n### `menu-item` as props\n\n_Example:_\n\n`1\n\n\"vtex.menu@2.x:menu#websites\": { \n\n2\n\n \"props\": { \n\n3\n\n \"items\": [ \n\n4\n\n { \n\n5\n\n \"id\": \"menu-item-shop\", \n\n6\n\n \"type\": \"custom\", \n\n7\n\n \"highlight\": false, \n\n8\n\n \"itemProps\": { \n\n9\n\n \"type\": \"internal\", \n\n10\n\n \"href\": \"#\", \n\n11\n\n \"noFollow\": false, \n\n12\n\n \"tagTitle\": \"Shop\", \n\n13\n\n \"text\": \"Shop\" \n\n14\n\n } \n\n15\n\n }, \n\n16\n\n { \n\n17\n\n \"id\": \"menu-item-about-us\", \n\n18\n\n \"type\": \"custom\", \n\n19\n\n \"highlight\": false, \n\n20\n\n \"itemProps\": { \n\n21\n\n \"type\": \"internal\", \n\n22\n\n \"href\": \"/about-us\", \n\n23\n\n \"noFollow\": false, \n\n24\n\n \"tagTitle\": \"about-us\", \n\n25\n\n \"text\": \"About Us\" \n\n26\n\n } \n\n27\n\n } \n\n28\n\n ] \n\n29\n\n } \n\n30\n\n} \n\n`\n\n### Adding a submenu\n\nYou can define a submenu by adding the `submenu` block to a `menu-item`:\n\n`1\n\n\"menu-item#shop\": { \n\n2\n\n \"props\": { \n\n3\n\n \"type\": \"custom\", \n\n4\n\n \"highlight\": false, \n\n5\n\n \"itemProps\": { \n\n6\n\n \"type\": \"internal\", \n\n7\n\n \"href\": \"#\", \n\n8\n\n \"noFollow\": false, \n\n9\n\n \"tagTitle\": \"Shop\", \n\n10\n\n \"text\": \"Shop\" \n\n11\n\n }, \n\n12\n\n }, \n\n13\n\n \"blocks\": [\"vtex.menu@2.x:submenu#shop\"] // Defining a submenu \n\n14\n\n}, \n\n15\n\n\"vtex.menu@2.x:submenu#shop\": { \n\n16\n\n \"children\": [ \n\n17\n\n \"vtex.menu@2.x:menu#submenushop\" \n\n18\n\n ] \n\n19\n\n}, \n\n20\n\n\"vtex.menu@2.x:menu#submenushop\": { \n\n21\n\n \"children\": [ \n\n22\n\n \"menu-item#shop\" \n\n23\n\n ] \n\n24\n\n} \n\n`\n\n> The Menu block doesn't require any specific child blocks to work\n\n## `menu-item` props\n\nThe available `menu-item` block props are:\n\n| Prop name | Type | Description | Default value |\n| --------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| type | string | Menu item type, either category or custom | category |\n| id | string | Menu item ID | undefined |\n| highlight | boolean | Indicates whether the item has a highlight | undefined |\n| iconPosition | string | Icon position relative to the menu item text, either to the left or right | left |\n| iconProps | IconProps | Icon props | undefined |\n| onMountBehavior | enum | Indicates whether the submenu should always be automatically displayed when its parent is hovered/clicked on (open) or (close) | closed |\n| itemProps | CategoryItem or CustomItem | Item props | undefined |\n| blockClass | CustomCSSClasses | Used to override default CSS handles. To learn how this prop works, check this description of [useCustomClasses](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Please note that this is only useful when importing this block as a React component. | undefined |\n\n### Icon props\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------- | ------------------------------------- | ------------- |\n| id | string | Icon ID | N/A |\n| isActive | boolean | Indicates if the item is active | true |\n| size | number | Icon size | 16 |\n| viewBox | string | Icon view box | 0 0 16 16 |\n| activeClassName | string | Icon classname when isActive is true | N/A |\n| mutedClassName | string | Icon classname when isActive is false | N/A |\n\n### Category-specific props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | ---------------- | ------------- |\n| categoryId | number | Item category ID | N/A |\n| text | string | Menu item text | N/A |\n\n### Custom item props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------- | ------------------------------------------- | ------------- |\n| type | string | Menu item type, either internal or external | internal |\n| href | string | Link to the menu item destination | N/A |\n| noFollow | boolean | No follow attribute | N/A |\n| tagTitle | string | Menu item tag | N/A |\n| text | string | Menu item text | N/A |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, please follow the instructions in [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handle |\n| ------------------------ |\n| accordionIcon--isClosed |\n| accordionIcon--isOpen |\n| accordionIcon |\n| container |\n| linkLeft |\n| linkMiddle |\n| linkRight |\n| menuContainerNav |\n| menuContainer |\n| menuItemInnerDiv |\n| menuItem |\n| menuItem--isOpen |\n| menuItem--isClosed |\n| menuLinkDivLeft |\n| menuLinkDivMiddle |\n| menuLinkDivRight |\n| menuLinkNav |\n| renderLink |\n| styledLinkContainer |\n| styledLinkContent |\n| styledLinkIcon |\n| styledLink |\n| submenuAccordion |\n| submenuColumn |\n| submenuContainer |\n| submenuWrapper--isClosed |\n| submenuWrapper--isOpen |\n| submenuWrapper |\n| submenu |\n\n[Login« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.login)[MinicartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.minicart)\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-menu/docs/apps/vtex.menu%23configuration)\n\n[menu-item as children](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.menu%23menu-item-as-children)[menu-item as props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.menu%23menu-item-as-props)[Adding a submenu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.menu%23adding-a-submenu)\n\n[menu-item props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.menu%23menu-item-props)\n\n[Icon props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.menu%23icon-props)[Category-specific props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.menu%23category-specific-props)[Custom item props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.menu%23custom-item-props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/docs/apps/vtex.menu%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_0544a7a0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides validating a layout before moving it to production in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/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/validating-a-layout-before-moving-it-to-production/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)\n\n[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/can-i-order-my-product-as-i-want)\n\n[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/list-of-controls-for-templates)\n\n[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/creating-gift-lists)\n\n[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/validating-a-layout-before-moving-it-to-production)\n\n[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/how-to-use-the-page-title-control)\n\n[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/how-product-name-control-works)\n\n[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/shelf-template-controls)\n\n[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/control-to-disable-the-canonical-tag)\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/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/validating-a-layout-before-moving-it-to-production/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)\n\n[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/can-i-order-my-product-as-i-want)\n\n[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/list-of-controls-for-templates)\n\n[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/creating-gift-lists)\n\n[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/validating-a-layout-before-moving-it-to-production)\n\n[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/how-to-use-the-page-title-control)\n\n[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/how-product-name-control-works)\n\n[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/shelf-template-controls)\n\n[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/control-to-disable-the-canonical-tag)\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/storefront-development)\n\n(Legacy) CMS Portal\n\n[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/validating-a-layout-before-moving-it-to-production)\n\nValidating a layout before moving it to production\n\nThere is no independent QA environment for testing layout changes.\n\nHowever, there are two ways to do these tests without having to put the changes into production.\n\n## Testing changes using the Layout ID (LID)\n\nEvery layout created in the CMS module has a specific ID (the `LID`).\n\nThis ID can be used as a parameter in the URL for the corresponding layout to be accessed.\n\nWith that you can:\n\n1. Duplicate the layout.\n2. Make the desired changes in the duplicate layout, keeping the first layout as default (ie, the second layout will not be accessible by the default URL of your store).\n3. Access the second layout using the `LID` parameter.\n4. Test whatever you want.\n5. Incorporate the desired changes into the original layout, that is, into the one in production.\n\nTo find the `LID`, simply access the layout in the CMS module Admin. It's in the **Properties** section, as the image below indicates:\n\n\n\nTo access the store page with the new layout, you must enter a question mark at the end of the URL and then the `LID` parameter.\n\nFor example:`{AccountName}.vtexcommercestable.com.br?lid=3536da96-963c-4844-bf52-cc978113be09`\n\n## Testing changes using the Web Site ID (WID)\n\nAnother alternative that allows you to test layout changes before moving to production is to create a new Web Site and access it through its specific ID (`WID`).\n\n1. Duplicate the web site in the CMS module.\n2. Make the desired changes on the duplicate web site. In this case, you can change as many layouts as you want.\n3. Access the second web site via the `WID` parameter.\n4. Test whatever you want.\n5. Incorporate the desired changes to the original web site, that is, the one in production.\n\nTo find the `WID`, visit the web site. It sits on the first field of the webpage screen: **WebSite Id**.\n\n\n\nRemember that although with the duplication of the web site you can change the layouts of the new web site independently, they will consume the same templates as the original web site.\n\nSo, depending on the changes you want to test, you may need to create new templates to feed the new layouts.\n\nContributors\n\n2\n\n[](https://github.com/acnmello)\n\n[](https://github.com/jumeyermattosarruda)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/legacy-cms/validating-a-layout-before-moving-it-to-production.md)\n\n[Creating gift lists« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production//docs/guides/creating-gift-lists)[How to use the page title controlNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production//docs/guides/how-to-use-the-page-title-control)\n\nContributors\n\n2\n\n[](https://github.com/acnmello)\n\n[](https://github.com/jumeyermattosarruda)\n\nON THIS PAGE\n\n[Testing changes using the Layout ID (LID)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/validating-a-layout-before-moving-it-to-production%23testing-changes-using-the-layout-id-lid)\n\n[Testing changes using the Web Site ID (WID)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/validating-a-layout-before-moving-it-to-production%23testing-changes-using-the-web-site-id-wid)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/legacy-cms/validating-a-layout-before-moving-it-to-production.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Testing changes using the Layout ID (LID)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/validating-a-layout-before-moving-it-to-production%23testing-changes-using-the-layout-id-lid)\n\n[Testing changes using the Web Site ID (WID)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/validating-a-layout-before-moving-it-to-production/docs/guides/validating-a-layout-before-moving-it-to-production%23testing-changes-using-the-web-site-id-wid)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_081e6214
|
[
{
"role": "system",
"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 audience 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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-api/docs/api-reference/audience-api/)\n\nAudience Manager\n\nPrice Table Mapper\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-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/audience-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/audience-api/docs/api-reference/audience-api/)\n\nAudience Manager\n\nPrice Table Mapper\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-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/audience-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Ge4\\. Get Credentials« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api/docs/api-reference/antifraud-provider-protocol%23get-/authorization/credentials)[PoFetch audienceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api/docs/api-reference/audience-api%23post-/api/audience-manager/pvt/audience)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_efb0ba6f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation managing application logs in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n[Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs)\n\n[Running IO scripts in non-IO VTEX stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)\n\n[Creating an interface for your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n[Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs)\n\n[Running IO scripts in non-IO VTEX stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)\n\n[Creating an interface for your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/app-development)\n\nDevelopment guides\n\n[Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs)\n\nManaging application logs\n\nVTEX IO provides a logging service that allows developers to keep track of app errors, warnings, and informative events. The VTEX IO Logging Service collects data from the cloud infrastructure where VTEX applications run and delivers them via the VTEX IO CLI.\n\nIn the following section, you'll learn how to implement the VTEX IO Logging Service in your apps and how to retrieve their respective logs.\n\n> The VTEX IO Logging Service is currently available for Node apps only.\n\n---\n\n## Before you begin\n\nTo follow this guide, you must have the VTEX IO CLI installed on your machine. For more information, please see [this document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install).\n\n---\n\n## Instructions\n\n### Implementing the VTEX IO Logging Service\n\n1. Open your Node app in the code editor of your choice.\n2. Define an object with the `Context` interface as a parameter in a function where you want to provide logging messages. See the following example:\n\n`1\n\nconst helloWorld = (ctx: Context) => { \n\n2\n\n const { vtex: { logger } } = ctx \n\n3\n\n \n4\n\n logger.info('Hello World!') \n\n5\n\n} \n\n`\n\nIn this example, the `helloWorld` function receives an object with a [**Context**](https://read.calvincode.net/reader?url=https://github.com/vtex/node-vtex-api/blob/master/src/service/worker/runtime/typings.ts%23L34) interface as a parameter.\n\n> The `Context` interface contains many implementations inherent to the VTEX IO platform. One of those implementations is called `vtex` — an object containing all [VTEX IO infrastructure](https://read.calvincode.net/reader?url=https://github.com/vtex/node-vtex-api/blob/master/src/service/worker/runtime/typings.ts%23L116) related metadata, such as `account`, `workspace`, `tenant`, `settings`, and some service implementations. In the previous example, we used the `logger` service, an implementation inside `vtex` that generates log messages.\n\n1. [Destructure](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/variable-declarations.html%23destructuring) the `logger` object from the `vtex` context and use its methods (`error`, `warn`, `info`, and `debug`) to provide error, warning, debugging, or informative messages in the log. See the following example:\n\n`1\n\nconst helloWorld = (ctx: Context) => { \n\n2\n\n const { vtex: { logger } } = ctx \n\n3\n\n \n4\n\n logger.warn('Warning the world!') \n\n5\n\n \n6\n\n logger.error('Error!!!') \n\n7\n\n \n8\n\n logger.debug('Verbose debug message!') \n\n9\n\n} \n\n`\n\n> Every exception that happens in a VTEX IO service app is intercepted and automatically logged with a `logger.error` implementation.\n\n### Retrieving app logs\n\nEvery log written by a running app with the VTEX IO Logging Service is collected and stored for later retrieval.\n\nYou can retrieve the logs using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) by following the steps:\n\n1. Log in to your VTEX account.\n2. Install the Logs plugin for the VTEX IO CLI by running the following command:\n\n`1\n\nvtex plugins add logs \n\n`\n\n1. Check if the installation of the Logs plugin was successful by running `vtex logs --help`.\n2. Retrieve logs from all apps installed in your account by running the following command:\n\n`1\n\nvtex logs --all \n\n`\n\nThe output should be a message similar to the following:\n\n`1\n\nvtex logs --all \n\n2\n\n18:15:26.779 - info: Connecting to logs stream for store components \n\n3\n\n18:15:26.782 - info: Press CTRL+C to abort \n\n4\n\n \n5\n\n18:15:43.856 - info: Listening to store components logs \n\n6\n\n \n7\n\n info: { status: 403, \n\n8\n\n code: 'FORBIDDEN', \n\n9\n\n name: 'ForbiddenError', \n\n10\n\n level: 'error', \n\n11\n\n message: 'This username is already registered with another email', \n\n12\n\n stack: \n\n13\n\n 'ForbiddenError: This username is already registered with another email[ErrorStack...] \n\n14\n\n routeId: 'login' } \n\n`\n\n> You can also retrieve logs from a specific app installed in your account by running the following command: `vtex logs {serviceAppExample}`. Replace `serviceAppExample` with the desired app name.\n\nWe suggest running `vtex logs --all > {mylogfile.logs}` to save the log messages in a local file. Replace `{mylogfile.logs}` with a name that fits your environment.\n\nIf you want to see log messages that you have previously retrieved, run `vtex logs --past`.\n\n## Log storage and retention limits\n\nVTEX limits the storage size and retention period of logs to guarantee the stability and performance of the platform. The limits are:\n\n* Logs are stored for 7 days at most.\n* Each app can have up to 1 GB of logs stored per account. If an app generates more than 1 GB of logs in one account in 7 days or less, the oldest logs are deleted.\n\nIf you need more than 1 GB of logs per week for an app, we recommend retrieving and storing your logs before they reach the storage limit. You can check the size of the logs from the size of the retrieved files in your local environment. See the instructions in the [Retrieving app logs](#retrieving-app-logs) section.\n\n> VTEX may change the storage limits of app logs without additional notice. Check this documentation for the updated limit values.\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-managing-application-logs.md)\n\n[Deprecating an app« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs//docs/guides/vtex-io-documentation-deprecating-an-app)[Running IO scripts in non-IO VTEX storesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs//docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23instructions)\n\n[Implementing the VTEX IO Logging Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23implementing-the-vtex-io-logging-service)[Retrieving app logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23retrieving-app-logs)\n\n[Log storage and retention limits](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23log-storage-and-retention-limits)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-managing-application-logs.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23instructions)\n\n[Implementing the VTEX IO Logging Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23implementing-the-vtex-io-logging-service)[Retrieving app logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23retrieving-app-logs)\n\n[Log storage and retention limits](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23log-storage-and-retention-limits)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_2a1d5d4a
|
[
{
"role": "system",
"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 data subject rights 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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/data-subject-rights-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/data-subject-rights-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/data-subject-rights-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/data-subject-rights-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/data-subject-rights-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-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/data-subject-rights-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Anti-fraud Provider APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/data-subject-rights-api/docs/api-reference/antifraud-provider-protocol)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_3d12d954
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore molecules toggle in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-overview)\n\nToggle\n\nToggle is a customized checkbox input styled to look like a switch button.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Toggle)\n\nThe Toggle is a customized checkbox input styled to look like a switch button.\n\nExample\n\nCode\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Toggle } from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/molecules/Toggle/styles.scss\"; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Examples\n\n### Variants\n\n#### Checked\n\nExample\n\nCode\n\n#### Disabled\n\nExample\n\nCode\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | ----------------------------------------- |\n| \\--fs-toggle-height | calc(var(--fs-control-min-height) / 1.75) |\n| \\--fs-toggle-bkg-color | var(--fs-control-bkg) |\n| \\--fs-toggle-bkg-color-hover | var(--fs-color-primary-bkg-light) |\n| \\--fs-toggle-shadow | var(--fs-shadow) |\n| \\--fs-toggle-shadow-hover | var(--fs-shadow) |\n| \\--fs-toggle-border-color | var(--fs-border-color) |\n| \\--fs-toggle-border-color-hover | var(--fs-border-color-hover) |\n| \\--fs-toggle-border-radius | var(--fs-border-radius) |\n| \\--fs-toggle-border-width | var(--fs-border-width) |\n| \\--fs-toggle-transition-timing | var(--fs-transition-timing) |\n| \\--fs-toggle-transition-property | var(--fs-transition-property) |\n| \\--fs-toggle-transition-function | var(--fs-transition-function) |\n\n### Knob\n\n| Local token | Default value/Global token linked |\n| --------------------------------------- | ---------------------------------------- |\n| \\--fs-toggle-knob-shadow | var(--fs-shadow) |\n| \\--fs-toggle-knob-bkg-color | var(--fs-color-primary-bkg) |\n| \\--fs-toggle-knob-bkg-color-hover | var(--fs-toggle-border-color-hover) |\n| \\--fs-toggle-knob-border-radius | var(--fs-border-radius-small) |\n| \\--fs-toggle-knob-border-color | var(--fs-toggle-knob-bkg-color) |\n| \\--fs-toggle-knob-border-color-hover | var(--fs-toggle-knob-bkg-color-hover) |\n| \\--fs-toggle-knob-border-width | var(--fs-border-width-thick) |\n| \\--fs-toggle-knob-checked-bkg-color | var(--fs-control-bkg) |\n| \\--fs-toggle-knob-checked-border-color | var(--fs-toggle-knob-checked-bkg-color) |\n| \\--fs-toggle-knob-disabled-bkg-color | var(--fs-color-neutral-5) |\n| \\--fs-toggle-knob-disabled-border-color | var(--fs-toggle-knob-disabled-bkg-color) |\n\n### Icon\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------ | ---------------------------------------- |\n| \\--fs-toggle-knob-icon-color | transparent |\n| \\--fs-toggle-knob-icon-checked-color | var(--fs-toggle-checked-bkg-color) |\n| \\--fs-toggle-knob-icon-checked-color-hover | var(--fs-toggle-checked-bkg-color-hover) |\n| \\--fs-toggle-knob-icon-disabled-color | var(--fs-toggle-disabled-bkg-color) |\n\n### Design tokens: Checked\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | ---------------------------------------- |\n| \\--fs-toggle-checked-bkg-color | var(--fs-color-primary-bkg-active) |\n| \\--fs-toggle-checked-bkg-color-hover | var(--fs-color-primary-bkg-hover) |\n| \\---fs-toggle-checked-border-color | var(--fs-toggle-checked-bkg-color) |\n| \\--fs-toggle-knob-icon-disabled-color | var(--fs-toggle-checked-bkg-color-hover) |\n\n### Design tokens: Disabled\n\n| Local token | Default value/Global token linked |\n| ----------------------------------- | --------------------------------- |\n| \\--fs-toggle-disabled-bkg-color | var(--fs-color-disabled-bkg) |\n| \\---fs-toggle-disabled-border-color | var(--fs-border-color-disabled) |\n\n---\n\n## Data attributes\n\nYou can target and override `Toggle` styles using the following data attributes:\n\n`data-fs-toggle`\n\n`data-fs-toggle-variant=\"horizontal\"`\n\n`data-fs-toggle-variant=\"vertical\"`\n\n`data-fs-toggle-knob`\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| ------------ | -------------------------- | -------------------------------------------------------------------------------------- | ---------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-toggle |\n| **id\\*** | string | ID to identify input and corresponding label. | |\n| **disabled** | false \\| true | Specifies that this input should be disabled. | |\n| **variant** | \"horizontal\" \\| \"vertical\" | Controls the component's direction. | horizontal |\n\n---\n\n## Related components\n\n* ToggleField \nToggleField \nToggleField wraps a Toggle input and its corresponding Label. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle-field)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/toggle.mdx)\n\n[Toast« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toast)[ToggleFieldNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle-field)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23design-tokens)\n\n[Knob](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23knob)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23icon)[Design tokens: Checked](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23design-tokens-checked)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23props)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23related-components)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/toggle.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23design-tokens)\n\n[Knob](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23knob)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23icon)[Design tokens: Checked](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23design-tokens-checked)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%23props)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle/docs/guides/faststore/molecules-toggle%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_d2bfdc14
|
[
{
"role": "system",
"content": "You are a VTEX 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 3 integrating the vtex checkout in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/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-3-integrating-the-vtex-checkout/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-overview)\n\n3\\. Integrating the VTEX Checkout\n\nIn this guide, you'll learn how to integrate your **FastStore** project with the [**VTEX Checkout**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/checkout-vtex-overview--7wcprkM7yZUflOqbzAN5SI). The Checkout comprehends the pages responsible for receiving the shopper's information necessary to process an order.\n\nTo successfully integrate the VTEX Checkout with your FastStore project, you must ensure that:\n\n* Shoppers will be presented with an updated version of the Order Placed page once they place an order.\n* All links in the Header and Footer of the Checkout point to your FastStore website.\n\n---\n\n## Before you begin\n\nBefore proceeding any further, make sure you have already [configured the custom domain name of your FastStore website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns).\n\n---\n\n## Instructions\n\n### Step 1 - Setting up the Order Placed page\n\nTake the following steps to guarantee shoppers will be redirected to the newest version of the **Order Placed** page in your store:\n\n1. In the **VTEX Admin**, access **Store Settings > Storefront > Checkout**.\n2. Click on the **gear button** `⚙` in the **Default** card.\n3. Change to the **Code** tab.\n4. Select `checkout-confirmation-custom.js` under **Files**.\n5. Add the following JavaScript code in the editor: \ncheckout-confirmation-custom.js \n`` 1 \n// WARNING: THE USAGE OF CUSTOM SCRIPTS IS NOT SUPPORTED. VTEX IS NOT LIABLE FOR ANY DAMAGES THIS MAY CAUSE. \n2 \n// THIS MAY BREAK YOUR STORE AND STOP SALES. IN CASE OF ERRORS, PLEASE DELETE THE CONTENT OF THIS SCRIPT. \n3 \n \n4 \nconst og = new URLSearchParams(location.search).get('og') \n5 \nwindow.location.assign( \n6 \n `${window.location.origin}/api/io${window.location.pathname}?og=${og}` \n7 \n) \n ``\n6. Click on **Save**. Notice that, as soon as you hit the _Save_ button, your changes will be live to all clients. \n\n\n### Step 2 - Adjusting the Header and Footer links of the Checkout pages\n\nWe now need to update the links presented in the Header and Footer of the Checkout pages, guaranteeing that all links point to your FastStore website. To do that, take the following steps.\n\n1. Still in the VTEX Admin at the **Store Settings > Storefront > Checkout > Default > Code** tab, click on `checkout-header` under **Template**.\n2. Edit the `checkout-header` code according to your scenario, making sure all links are pointing to your FastStore website. For example: \ncheckout-header.js \n`1 \n<div class=\"container\"> \n2 \n- <a href=\"/\" title=\"Home Page\">Your logo here!</a> \n3 \n+ <a href=\"https://www.vtexfaststore.com\" title=\"Home Page\">FastStore</a> \n4 \n<hr> \n5 \n</div> \n`\n3. Click on **Save**. Notice that, as soon as you hit the _Save_ button, your changes will be live to all clients.\n\nOnce you adjust all the Header links of the Checkout pages, make sure to repeat the process in the [step 2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout%23step-2---adjusting-the-header-and-footer-links-of-the-checkout-pages) for the `checkout-footer` file to adjust the Checkout Footer.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/3-integrating-the-vtex-checkout.mdx)\n\n[2\\. Integrating the VTEX Login« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-2-integrating-the-vtex-login)[4\\. Integrating the VTEX Order Placed and My AccountNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23instructions)\n\n[Step 1 - Setting up the Order Placed page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23step-1-setting-up-the-order-placed-page)[Step 2 - Adjusting the Header and Footer links of the Checkout pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23step-2-adjusting-the-header-and-footer-links-of-the-checkout-pages)\n\nWas this helpful?\n\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/3-integrating-the-vtex-checkout.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23instructions)\n\n[Step 1 - Setting up the Order Placed page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23step-1-setting-up-the-order-placed-page)[Step 2 - Adjusting the Header and Footer links of the Checkout pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23step-2-adjusting-the-header-and-footer-links-of-the-checkout-pages)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_c004be22
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation policies in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-policies)\n\n[Accessing external resources within a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/accessing-external-resources-within-a-vtex-io-app)\n\n[Controlling access to app resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/controlling-access-to-app-resources)\n\n[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-roles)\n\n[VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-vrn)\n\n[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-policies-from-license-manager)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-policies)\n\n[Accessing external resources within a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/accessing-external-resources-within-a-vtex-io-app)\n\n[Controlling access to app resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/controlling-access-to-app-resources)\n\n[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-roles)\n\n[VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-vrn)\n\n[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-policies-from-license-manager)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/app-development)\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-policies)\n\nPolicies\n\nLearn about policies in VTEX IO and what they are used for.\n\nPolicies are a set of permissions granted to a resource ([VRN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vrn)) or a [role](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles) that allows or forbids them to execute a given set of actions in an account, such as making a request to the platform.\n\nIn VTEX IO, apps interact with policies in two ways:\n\n* Using policies to [access to an **external resource**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/accessing-external-resources-within-a-vtex-io-app), such as an endpoint exposed by another VTEX IO app.\n* [Exposing policies to define how other apps, users, or services can securely access the resources they provide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources).\n\n## Types of policies\n\nThere are two kinds of policies: role-based and resource-based. Both are based on [AWS's IAM policies](https://read.calvincode.net/reader?url=https://docs.aws.amazon.com/IAM/latest/UserGuide/access%5Fpolicies.html).\n\n> Understanding the difference between role-based and resource-based policies is especially important when exposing a new policy, since the type determines where the policy must be declared and how it will be evaluated by the platform.\n\nAs the name suggests, **role-based policies** are associated with a role in the platform, for example, a role assumed by an app. In this case, these policies must be declared in the `policies.json` file in the app's root folder.\n\n**Resource-based policies**, in turn, are policies assigned to a resource in the platform, such as an API endpoint. In this case, the resource itself must declare which apps, users, and services it trusts, and provide information about the context in which those roles should be trusted. Since an app declares its routes in a `service.json` file, this is also the file in which the resource-based policies must be declared.\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-policies.md)\n\n[Admin GraphQL IDE« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies//docs/guides/graphql-ide)[Accessing external resources within a VTEX IO appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies//docs/guides/accessing-external-resources-within-a-vtex-io-app)\n\nSee also\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Types of policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-policies%23types-of-policies)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-policies.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Types of policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies/docs/guides/vtex-io-documentation-policies%23types-of-policies)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4d7bba3a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore override use cases overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-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/override-use-cases-overview/docs/guides/faststore/overrides-overview)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/override-use-cases-overview)\n\n[Adding more icon options to the Alert component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/override-use-cases-adding-more-icon-options-to-the-alert-component)\n\n[Adding an image to the Alert component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides//faststore/override-use-cases-adding-an-image-to-the-alert-component)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-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/override-use-cases-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/override-use-cases-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/override-use-cases-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/override-use-cases-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-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/override-use-cases-overview/docs/guides/faststore/overrides-overview)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/override-use-cases-overview)\n\n[Adding more icon options to the Alert component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/override-use-cases-adding-more-icon-options-to-the-alert-component)\n\n[Adding an image to the Alert component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides//faststore/override-use-cases-adding-an-image-to-the-alert-component)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-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/override-use-cases-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/override-use-cases-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/override-use-cases-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/override-use-cases-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\nSection override use cases\n\nThe Section override use cases provide an introduction, instructions for implementation, and results in the storefront, showing how we can implement [section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview). These examples can help you understand and leverage this feature.\n\n| Use case | Description |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [Adding more icon options to the Alert component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-more-icon-options-to-the-alert-component) | Add more icon options to the Alert, allowing editors to choose from a wider selection of icons supported by the @faststore/ui [iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons%23usage) library. |\n| [Adding an image to your Alert component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component) | Make alert messages more engaging by allowing images alongside text content. |\n\n> You can find the code for each use case in the [playground.store](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store) repository, which provides more in-depth details of the examples.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/override-use-cases/overview.mdx)\n\n[Overriding native components and props (v1)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/overrides-components-and-props-v1)[Adding more icon options to the Alert componentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-overview/docs/guides/faststore/override-use-cases-adding-more-icon-options-to-the-alert-component)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/override-use-cases/overview.mdx)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e233cb2f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore molecules textarea field in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-overview)\n\nTextareaField\n\nMulti-line text fields used to get long user inputs.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/TextareaField)\n\n`TextareaField` is a multi-line text field component to get long user inputs. The component wraps a [Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea) and its corresponding [Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label).\n\nExample\n\nCode\n\nLabel\n\nInput w/ Error MessageError Message\n\nInput Disabled\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { TextareaField } from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/molecules/TextareaField/styles.scss\"; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Examples\n\n### With label\n\nExample\n\nCode\n\nLabel\n\n### Variants\n\n#### Error\n\nExample\n\nCode\n\nInput w/ Error MessageError Message\n\n#### Disabled\n\nExample\n\nCode\n\nInput Disabled\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | --------------------------------- |\n| \\--fs-textarea-width | 100% |\n| \\--fs-textarea-height | 100% |\n| \\--fs-textarea-field-padding | 18px var(--fs-spacing-2) 0 |\n| \\--fs-textarea-field-color | var(--fs-color-text) |\n| \\--fs-textarea-field-size | var(--fs-text-size-body) |\n| \\--fs-textarea-field-border-color | var(--fs-border-color) |\n| \\--fs-textarea-field-transition-function | var(--fs-transition-function) |\n| \\--fs-textarea-field-transition-property | var(--fs-transition-property) |\n| \\--fs-textarea-field-transition-timing | var(--fs-transition-timing) |\n\n### Label\n\n| Local token | Default value/Global token linked |\n| -------------------------------------------------- | ---------------------------------------------------------------------------------------- |\n| \\--fs-textarea-field-label-placeholder-top-padding | var(--fs-spacing-2) |\n| \\--fs-textarea-field-label-max-width | var(--fs-textarea-width) |\n| \\--fs-textarea-field-label-max-height | calc(var(--fs-textarea-height) - var(--fs-textarea-field-label-placeholder-top-padding)) |\n| \\--fs-textarea-field-label-padding | 0 var(--fs-spacing-2) |\n| \\--fs-textarea-field-label-color | var(--fs-color-text-light) |\n| \\--fs-textarea-field-label-size | var(--fs-text-size-tiny) |\n\n### Button\n\n| Local token | Default value/Global token linked |\n| ---------------------------------- | --------------------------------- |\n| \\--fs-textarea-field-button-height | var(--fs-control-tap-size) |\n\n### Variants\n\n#### Error\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------------- | ------------------------------------------------------------------------ |\n| \\--fs-textarea-field-error-message-size | var(--fs-text-size-legend) |\n| \\--fs-textarea-field-error-message-line-height | 1.1 |\n| \\--fs-textarea-field-error-message-margin-top | var(--fs-spacing-0) |\n| \\--fs-textarea-field-error-message-color | var(--fs-color-danger-text) |\n| \\--fs-textarea-field-error-border-color | var(--fs-color-danger-border) |\n| \\--fs-textarea-field-error-box-shadow | 0 0 0 var(--fs-border-width) var(--fs-textarea-field-error-border-color) |\n| \\--fs-textarea-field-error-focus-ring | var(--fs-color-focus-ring-danger) |\n\n#### Disabled\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------ | --------------------------------- |\n| \\--fs-textarea-field-disabled-bkg-color | var(--fs-color-disabled-bkg) |\n| \\--fs-textarea-field-disabled-text-color | var(--fs-color-disabled-text) |\n| \\--fs-textarea-field-disabled-border-width | var(--fs-border-width) |\n| \\--fs-textarea-field-disabled-border-color | var(--fs-border-color) |\n\n---\n\n## Data attributes\n\nYou can target and override `TextareaField` styles using the following data attributes:\n\n`data-fs-textarea-field`\n\n`data-fs-textarea-field-label`\n\n`data-fs-textarea-field-error`\n\n`data-fs-textarea-field-error-message`\n\n---\n\n## Props\n\n| Name | Type | Description | Default | |\n| ---------- | -------------------- | ------------ | ------- | -------------------------------------------------------------------------------------------------------- |\n| **resize** | \"none\" \\| \"vertical\" | \"horizontal\" | \"both\" | Controls the resize property of the textare (e.g.: none, vertical, horizontal, both). Default is 'both'. |\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/faststore/components/molecules/textarea-field.mdx)\n\n[Tag« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-tag)[ToastNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-toast)\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[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23examples)\n\n[With label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23with-label)[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23design-tokens)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23label)[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23button)[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23variants)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23props)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/textarea-field.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23examples)\n\n[With label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23with-label)[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23design-tokens)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23label)[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23button)[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23variants)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-textarea-field/docs/guides/faststore/molecules-textarea-field%23props)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_41621310
|
[
{
"role": "system",
"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 specifications 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-specifications/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-specifications/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/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-specifications/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/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-specifications/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/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-specifications/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-specifications/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-specifications/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/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-specifications/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/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-specifications/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/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-specifications/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-specifications/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-specifications/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/guides/basic-components)\n\nProduct Specifications\n\nOfficial extension\n\nVersion: 1.1.2\n\nLatest version: 1.1.2\n\n[](#contributors-)\n\nThe Product Specifications app provides blocks to render product specification information.\n\n\n\n## Configuration\n\n### Step 1 - Adding the Product Specifications app to your theme dependencies\n\nIn your theme `manifest.json`, add the Product Specification app as a dependency:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.product-specifications\": \"1.x\" \n\n3\n\n} \n\n`\n\nNow, you can use all the blocks exported by the `product-specifications` app. See the full list below:\n\n| Block name | Description |\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| product-specification-group | Renders the product specification group. |\n| product-specification | Renders the product specification. It should be declared as a child of product-specification-group. |\n| product-specification-value | Renders the product specification value. It should be declared as a child of product-specification. It can be rendered with HTML. |\n| product-specification-text | Mandatory children of product-specification-group, product-specification, and product-specification-value. Depending on which block is declared, the product-specification-text renders information regarding a specification group, a specification, or a specification value. |\n\n### Step 2 - Adding the Product Specification blocks to your theme templates\n\nCopy the example below and paste it in the desired theme template, modifying it as necessary for your use case. If necessary, add the `product-specification-group` block to the template block list.\n\n`1\n\n{ \n\n2\n\n \"product-specification-group\": { \n\n3\n\n \"children\": [\"product-specification-text#group\", \"product-specification\"] \n\n4\n\n }, \n\n5\n\n \"product-specification\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"product-specification-text#specification\", \n\n8\n\n \"product-specification-values\" \n\n9\n\n ] \n\n10\n\n }, \n\n11\n\n \"product-specification-values\": { \n\n12\n\n \"children\": [\"product-specification-text#value\"] \n\n13\n\n }, \n\n14\n\n \"product-specification-text#group\": { \n\n15\n\n \"props\": { \n\n16\n\n \"message\": \"{groupName}\" \n\n17\n\n } \n\n18\n\n }, \n\n19\n\n \"product-specification-text#specification\": { \n\n20\n\n \"props\": { \n\n21\n\n \"message\": \"{specificationName}\" \n\n22\n\n } \n\n23\n\n }, \n\n24\n\n \"product-specification-text#value\": { \n\n25\n\n \"props\": { \n\n26\n\n \"message\": \"{specificationValue}\" \n\n27\n\n } \n\n28\n\n } \n\n29\n\n} \n\n`\n\n> The Product Specification blocks need a Product context to work properly because they handle product information. Therefore, when declaring them, be sure that they are in a theme template in which this context is available, such as `store.product`.\n\nYou can also use other blocks to wrap the blocks provided by the Product Specifications app, such as the ones exported by the [Flex Layout app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-flex-layout/). For example:\n\n`1\n\n{ \n\n2\n\n \"product-specification-group#table\": { \n\n3\n\n \"children\": [\"flex-layout.row#spec-group\"] \n\n4\n\n }, \n\n5\n\n \"flex-layout.row#spec-group\": { \n\n6\n\n \"props\": { \n\n7\n\n \"blockClass\": \"productSpecificationGroup\" \n\n8\n\n }, \n\n9\n\n \"children\": [\"flex-layout.col#spec-group\"] \n\n10\n\n }, \n\n11\n\n \"flex-layout.col#spec-group\": { \n\n12\n\n \"children\": [\"flex-layout.row#spec-group-name\", \"product-specification\"] \n\n13\n\n }, \n\n14\n\n \"flex-layout.row#spec-group-name\": { \n\n15\n\n \"props\": { \n\n16\n\n \"blockClass\": \"productSpecificationGroupName\" \n\n17\n\n }, \n\n18\n\n \"children\": [\"product-specification-text#group\"] \n\n19\n\n }, \n\n20\n\n \"product-specification\": { \n\n21\n\n \"children\": [\"flex-layout.row#spec-item\"] \n\n22\n\n }, \n\n23\n\n \"flex-layout.row#spec-item\": { \n\n24\n\n \"props\": { \n\n25\n\n \"blockClass\": \"productSpecification\" \n\n26\n\n }, \n\n27\n\n \"children\": [\"flex-layout.col#spec-name\", \"flex-layout.col#spec-value\"] \n\n28\n\n }, \n\n29\n\n \"flex-layout.col#spec-name\": { \n\n30\n\n \"props\": { \n\n31\n\n \"blockClass\": \"productSpecificationName\", \n\n32\n\n \"width\": { \n\n33\n\n \"mobile\": \"50%\", \n\n34\n\n \"desktop\": \"25%\" \n\n35\n\n } \n\n36\n\n }, \n\n37\n\n \"children\": [\"product-specification-text#specification\"] \n\n38\n\n }, \n\n39\n\n \"flex-layout.col#spec-value\": { \n\n40\n\n \"props\": { \n\n41\n\n \"blockClass\": \"productSpecificationValue\" \n\n42\n\n }, \n\n43\n\n \"children\": [\"product-specification-values\"] \n\n44\n\n }, \n\n45\n\n \"product-specification-values\": { \n\n46\n\n \"children\": [\"product-specification-text#value\"] \n\n47\n\n }, \n\n48\n\n \"product-specification-text#group\": { \n\n49\n\n \"props\": { \n\n50\n\n \"message\": \"{groupName}\" \n\n51\n\n } \n\n52\n\n }, \n\n53\n\n \"product-specification-text#specification\": { \n\n54\n\n \"props\": { \n\n55\n\n \"message\": \"{specificationName}\" \n\n56\n\n } \n\n57\n\n }, \n\n58\n\n \"product-specification-text#value\": { \n\n59\n\n \"props\": { \n\n60\n\n \"message\": \"{specificationValue}\" \n\n61\n\n } \n\n62\n\n } \n\n63\n\n} \n\n`\n\n### `product-specification-group` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------------------------- | ------------- |\n| filter | object | Filters the specifications that the block should display. | undefined |\n\n* **`filter` object:**\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| specificationGroups | \\[string\\] | Array of specification group names to be hidden or shown (depending on what is defined in the type property) by the product-specification-group block. | undefined |\n| type | enum | Determines whether the specification group names passed to the specificationGroups prop should be displayed or hidden on the UI. Possible values are: hide (hides specification groups declared in the specificationGroups prop) or show (only shows the specification groups declared in the specificationGroups prop). | undefined |\n\n#### `product-specification-text` props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| blockClass | string | Block ID of your choice to be used in [CSS customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23using-the-blockclass-property). | undefined |\n| message | string | Defines the block default text message to be rendered on the UI. You can also define the text message a block will render on the UI using the Site Editor in the Admin and the markers prop. | undefined |\n| markers | \\[string\\] | IDs of your choice to identify the block's rendered text message and customize it using the Site Editor in the Admin. Learn how to use them by reading the documentation on [Using the Markers prop to customize a block message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message). Note that a block message can also be customized in the Store Theme source code using the message prop. | \\[\\] |\n\n### Step 3 - Editing the `product-specification-text` messages\n\nAs stated in the previous step, the `product-specification-text` uses the [ICU Message Format](https://read.calvincode.net/reader?url=https://format-message.github.io/icu-message-format-for-translators/), making it possible to fully edit the block's rendered text messages.\n\nWhen using the `message` prop, you will not need to create an advanced configuration: declare the prop directly in your Store Theme app and pass to it the desired text value to be rendered with the block.\n\nThe `markers` prop, in turn, requires you to add an extra configuration in the Site Editor of the Admin to properly work. When using this prop, do not forget to check out the block message variables (shown in the table below) and the [Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message) documentation.\n\n| Message variable | Type | Description |\n| ------------------------- | ------- | ----------------------------------------------------------------------------- |\n| groupName | string | Specification group name. |\n| specificationName | string | Specification name. |\n| specificationValue | string | Specification value. |\n| isFirstSpecificationValue | boolean | Determines whether it is the first specification value (true) or not (false). |\n| isLastSpecificationValue | boolean | Determines whether it is the last specification value (true) or not (false). |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS handles for store 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| groupName |\n| specificationName |\n| specificationValue |\n| specificationValue--first |\n| specificationValue--last |\n\n[Product Quantity« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-quantity)[Product SummaryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-summary)\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-specifications/docs/apps/vtex.product-specifications%23configuration)\n\n[Step 1 - Adding the Product Specifications app to your theme dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-specifications%23step-1-adding-the-product-specifications-app-to-your-theme-dependencies)[Step 2 - Adding the Product Specification blocks to your theme templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-specifications%23step-2-adding-the-product-specification-blocks-to-your-theme-templates)[product-specification-group props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-specifications%23product-specification-group-props)[Step 3 - Editing the product-specification-text messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-specifications%23step-3-editing-the-product-specification-text-messages)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specifications/docs/apps/vtex.product-specifications%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_1ed12e96
|
[
{
"role": "system",
"content": "You are a VTEX 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 colors in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-colors/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-colors/docs/api-reference)\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-colors/docs/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-colors/docs/storefront-development)\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-colors/docs/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-colors/docs/troubleshooting)\n\n[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-colors/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-colors/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-colors/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-colors/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-colors/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-colors/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/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-colors/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-overview)\n\n[Colors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/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-colors/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-colors/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-colors/docs/guides/faststore/global-tokens-refinements)\n\n[Spacing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-spacing)\n\n[Typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-typography)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/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-colors/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-colors/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-colors/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-colors/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-colors/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-colors/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-colors/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-colors/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/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-colors/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-colors/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-colors/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/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-colors/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-colors/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-colors/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-colors/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-colors/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/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-colors/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-overview)\n\n[Colors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/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-colors/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-colors/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-colors/docs/guides/faststore/global-tokens-refinements)\n\n[Spacing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-spacing)\n\n[Typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-typography)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/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-colors/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-colors/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-colors/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-colors/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-colors/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-colors/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-colors/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-colors/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/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-colors/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-colors/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-colors/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/styling-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-overview)\n\nColors\n\nThe store palette with all the tones needed.\n\nThe store palette with all the tones needed.\n\n## Main\n\n* \\--fs-color-main-0 \n`#f1f2f3`\n* \\--fs-color-main-1 \n`#dbdbdb`\n* \\--fs-color-main-2 \n`#00419e`\n* \\--fs-color-main-3 \n`#002c71`\n* \\--fs-color-main-4 \n`#002155`\n\n## Accent\n\n* \\--fs-color-accent-0 \n`#efeaf5`\n* \\--fs-color-accent-1 \n`#d3c9de`\n* \\--fs-color-accent-2 \n`#9d8abf`\n* \\--fs-color-accent-3 \n`#74678c`\n* \\--fs-color-accent-4 \n`#423759`\n\n## Neutral\n\n* \\--fs-color-neutral-0 \n`#ffffff`\n* \\--fs-color-neutral-1 \n`#f1f2f3`\n* \\--fs-color-neutral-2 \n`#e3e6e8`\n* \\--fs-color-neutral-3 \n`#c7ccd1`\n* \\--fs-color-neutral-4 \n`#9099a2`\n* \\--fs-color-neutral-5 \n`#74808b`\n* \\--fs-color-neutral-6 \n`#5d666f`\n* \\--fs-color-neutral-7 \n`#171a1c`\n\n---\n\n## Semantical tokens\n\n## Hierarchy\n\n| Global Token | Value |\n| -------------------------------------- | ----------------------------------- |\n| \\--fs-color-primary-text | var(--fs-color-text-inverse) |\n| \\--fs-color-primary-bkg | var(--fs-color-main-2) |\n| \\--fs-color-primary-bkg-hover | var(--fs-color-main-3) |\n| \\--fs-color-primary-bkg-active | var(--fs-color-main-4) |\n| \\--fs-color-primary-bkg-light | var(--fs-color-main-0) |\n| \\--fs-color-primary-bkg-light-active | var(--fs-color-main-1) |\n| \\--fs-color-secondary-text | var(--fs-color-primary-bkg) |\n| \\--fs-color-secondary-bkg | transparent |\n| \\--fs-color-secondary-bkg-hover | var(--fs-color-primary-bkg) |\n| \\--fs-color-secondary-bkg-active | var(--fs-color-main-3) |\n| \\--fs-color-secondary-bkg-light | var(--fs-color-main-0) |\n| \\--fs-color-secondary-bkg-light-active | var(--fs-color-secondary-bkg-light) |\n| \\--fs-color-tertiary-text | var(--fs-color-link) |\n| \\--fs-color-tertiary-bkg | transparent |\n| \\--fs-color-tertiary-bkg-hover | var(--fs-color-main-0) |\n| \\--fs-color-tertiary-bkg-active | var(--fs-color-main-1) |\n| \\--fs-color-tertiary-bkg-light | var(--fs-color-neutral-0) |\n| \\--fs-color-tertiary-bkg-light-active | var(--fs-color-tertiary-bkg-light) |\n\n## Components & States\n\n| Global Token | Value |\n| ----------------------------------- | ---------------------------------- |\n| \\--fs-color-body-bkg | var(--fs-color-neutral-0) |\n| \\--fs-body-bkg | \\--fs-color-body-bkg |\n| \\--fs-color-action-text | var(--fs-color-text-inverse) |\n| \\--fs-color-action-bkg | var(--fs-color-accent-4) |\n| \\--fs-color-action-bkg-hover | var(--fs-color-accent-3) |\n| \\--fs-color-action-bkg-active | var(--fs-color-accent-2) |\n| \\--fs-color-action-bkg-light | var(--fs-color-neutral-0) |\n| \\--fs-color-action-bkg-light-active | var(--fs-color-tertiary-bkg-light) |\n| \\--fs-color-link | var(--fs-color-main-2) |\n| \\--fs-color-link-hover | var(--fs-color-main-2) |\n| \\--fs-color-link-active | var(--fs-color-main-4) |\n| \\--fs-color-link-visited | #6058ba |\n| \\--fs-color-link-inverse | var(--fs-color-neutral-0) |\n| \\--fs-color-text | var(--fs-color-neutral-7) |\n| \\--fs-color-text-light | var(--fs-color-neutral-6) |\n| \\--fs-color-text-inverse | var(--fs-color-neutral-0) |\n| \\--fs-color-text-display | var(--fs-color-neutral-7) |\n| \\--fs-color-focus-ring | #8db6fa |\n| \\--fs-color-focus-ring-outline | #8db6fa80 |\n| \\--fs-color-focus-ring-danger | #e1adad |\n\n## Situations\n\n| Global Token | Value |\n| ---------------------------- | --------------------------------- |\n| \\--fs-color-success-text | #1e493b |\n| \\--fs-color-success-bkg | #b3ebd5 |\n| \\--fs-color-success-border | var(--fs-color-success-text) |\n| \\--fs-color-warning-text | var(--fs-color-text) |\n| \\--fs-color-warning-bkg | #fdec8d |\n| \\--fs-color-warning-border | var(--fs-color-warning-text) |\n| \\--fs-color-danger-text | #cb4242 |\n| \\--fs-color-danger-bkg | var(--fs-color-focus-ring-danger) |\n| \\--fs-color-danger-border | var(--fs-color-danger-text) |\n| \\--fs-color-info-text | var(--fs-color-text) |\n| \\--fs-color-info-bkg | var(--fs-color-main-1) |\n| \\--fs-color-highlighted-text | var(--fs-color-text-display) |\n| \\--fs-color-highlighted-bkg | var(--fs-color-accent-0) |\n| \\--fs-color-neutral-text | var(--fs-color-text) |\n| \\--fs-color-neutral-bkg | var(--fs-color-neutral-1) |\n| \\--fs-color-disabled-text | var(--fs-color-neutral-6) |\n| \\--fs-color-disabled-bkg | var(--fs-color-neutral-2) |\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/colors.mdx)\n\n[Global tokens« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-overview)[Grid and LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-grid-and-layout)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Main](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23main)\n\n[Accent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23accent)\n\n[Neutral](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23neutral)\n\n[Semantical tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23semantical-tokens)\n\n[Hierarchy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23hierarchy)\n\n[Components & States](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23components--states)\n\n[Situations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23situations)\n\nWas this helpful?\n\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/colors.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Main](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23main)\n\n[Accent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23accent)\n\n[Neutral](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23neutral)\n\n[Semantical tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23semantical-tokens)\n\n[Hierarchy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23hierarchy)\n\n[Components & States](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23components--states)\n\n[Situations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-colors/docs/guides/faststore/global-tokens-colors%23situations)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_04b2e700
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides payments integration payment methods in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-guide)\n\n[Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/integrating-a-new-payment-provider-on-vtex)\n\n[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-provider-protocol)\n\n[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-ppp-applied-to-pos)\n\n[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-implementing-a-payment-provider)\n\n[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n\n[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-secure-proxy)\n\n[Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/split-payouts-on-payment-provider-protocol)\n\n[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)\n\n[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/custom-auto-capture-feature)\n\n[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-pix-instant-payments-in-brazil)\n\n[PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/pse-payment-method)\n\n[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-guide)\n\n[Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/integrating-a-new-payment-provider-on-vtex)\n\n[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-provider-protocol)\n\n[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-ppp-applied-to-pos)\n\n[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-implementing-a-payment-provider)\n\n[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n\n[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-secure-proxy)\n\n[Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/split-payouts-on-payment-provider-protocol)\n\n[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)\n\n[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/custom-auto-capture-feature)\n\n[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-pix-instant-payments-in-brazil)\n\n[PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/pse-payment-method)\n\n[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-guide)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods)\n\nPayment Methods\n\nPayment methods are different ways that a customer can use money to buy a product or a service. In VTEX, the types of payment methods available are:\n\n* Credit Cards\n* Debit Cards\n* Cash\n* Custom Payments \n * Promissory \n * Private Labels \n * Co-Branded\n* Regional Payments \n * Instant Payments (Pix/Brazil) \n * Bank Invoice (Boleto Bancário/Brazil)\n\nDifferent countries use different payment methods. There is an extensive list of payment methods worldwide, especially because the payment methods differ from country to country. Before integrating with VTEX platform, it is important to know if the payment methods processed by your system are compatible with ours.\n\n## Credit Cards\n\nMost financial institutions can offer a credit limit to your account holders. This credit can be used as a payment method through a credit card. With that, the customer can make a purchase but pay for it in the near future.\n\nAlso, there is one more important thing about credit cards: the corporate flags - networks responsible for managing the credit card operations. MasterCard, Visa, Amex and Diners are examples of credit card networks in the payments industry. For more information, refer to [Credit card payment flow.](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/pagamentos--6GAS7ZzGAm7AGoEAwDbwJG/TEYVv2fcVkH7et9n3OnBS%23)\n\n## Debit Cards\n\nA card offered by a financial institution to its account holders. Using the debit card as a payment method, the purchases are paid right the way by deducting the money directly from the customer's bank account.\n\nIn the same way as credit cards, debit cards also work together with corporate flags.\n\n## Cash\n\nCash payments can be enabled in the inStore app. After having configured and enabled this payment method, a payment made with cash can be received at the brick–and–mortar store or when a product is delivered to the consumer in cases of delivery service. For more information, refer to [Setting up cash payment through inStore.](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/instore-payments--43B4Nr7uZva5UdwWEt3PEy/4ye3bIWldaHJxGTgAziBZo)\n\n## Custom Payments\n\nThere are some payment methods non-standard according to the payment market patterns - the Custom Payments. This means that these payment methods have a very specific behavior for every scenario that can be applied.\n\nIn VTEX, we majorly work with three of them: Promissory, Private Labels and Co-branded.\n\n### Promissory\n\nThe seller has to manually approve each payment that is computed in our system. After the approval, the transaction follows normally. The promissory is used mostly to facilitate payments made with cash.\n\n### Private Labels\n\nIt is a credit card made exclusively for a store that functions with its own brand.\n\n### Co-Branded\n\nAlso, a credit card made exclusively for a store. The difference between a private label and a co-branded is that the co-branded works with a partnership between a corporate credit card flag - like MasterCard and Visa - and the store’s brand.\n\n## Regional Payments\n\n### Instant Payments (Pix/Brazil)\n\nPix is the instant payments ecosystem implementation led by the Central Bank of Brazil (BCB) to enable online money transfers with reduced costs, increased safety and 24/7 availability. Transfers occur directly from the payer’s account to the payee’s account, without the need for intermediaries, resulting in lower transaction costs. For more information, refer to [Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil).\n\n### Bank Invoice (Boleto Bancário/Brazil)\n\nThe “boleto bancário” is a popular payment method in Brazil. It consists of an official voucher that a customer can pay in cash at more than 200 thousand payment locations such as banks, post offices, and supermarkets. It can also be paid electronically through internet banking. For more information, refer to [Bank Invoice payment flow](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/boleto-bancario-registrado-fluxo-basico-de-um-pagamento--1WlPkeueWQiykUwW8mcM4S%23).\n\nEven though the payment facilities, its disbursement can take two commercial days to be computed.\n\n> In VTEX's APIs, this payment method is registered as “bank invoice”.\n\n> For every payment method, there is a payment condition. You can learn how these terms work in VTEX checking our [101 Payments module track](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/6bzGxlz4inf8sKmvZ1c7i3).\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-payment-methods.md)\n\n[Payment App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods//docs/guides/payments-integration-payment-app)[Payment Provider HomologationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods//docs/guides/payments-integration-payment-provider-homologation)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Credit Cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23credit-cards)\n\n[Debit Cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23debit-cards)\n\n[Cash](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23cash)\n\n[Custom Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23custom-payments)\n\n[Promissory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23promissory)[Private Labels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23private-labels)[Co-Branded](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23co-branded)\n\n[Regional Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23regional-payments)\n\n[Instant Payments (Pix/Brazil)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23instant-payments-pixbrazil)[Bank Invoice (Boleto Bancário/Brazil)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23bank-invoice-boleto-bancriobrazil)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-payment-methods.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Credit Cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23credit-cards)\n\n[Debit Cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23debit-cards)\n\n[Cash](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23cash)\n\n[Custom Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23custom-payments)\n\n[Promissory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23promissory)[Private Labels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23private-labels)[Co-Branded](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23co-branded)\n\n[Regional Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23regional-payments)\n\n[Instant Payments (Pix/Brazil)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23instant-payments-pixbrazil)[Bank Invoice (Boleto Bancário/Brazil)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods/docs/guides/payments-integration-payment-methods%23bank-invoice-boleto-bancriobrazil)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_721be496
|
[
{
"role": "system",
"content": "You are a VTEX 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 search input in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-search-input/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-search-input/docs/api-reference)\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-search-input/docs/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-search-input/docs/storefront-development)\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-search-input/docs/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-search-input/docs/troubleshooting)\n\n[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-search-input/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-search-input/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-search-input/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/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-search-input/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-search-input/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-search-input/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/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-search-input/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/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-search-input/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/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-search-input/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-search-input/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-search-input/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/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-search-input/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-search-input/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-search-input/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-overview)\n\nSearch Input\n\nReceives, searches, and displays suggestions.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/SearchInput)\n\nThe `SearchInput` is responsible for receiving, searching, and displaying suggestions. This component is part of the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search) feature.\n\nExample\n\nCode\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { SearchInput } 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/SearchInput/styles.scss\"; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| --------------------------------- | --------------------------------- |\n| \\--fs-search-input-height-desktop | var(--fs-spacing-6) |\n\n---\n\n## Data attributes\n\nYou can target and override `SearchInput` styles using the following data attributes:`data-fs-search-input`\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| --------------------- | ------------------------------------ | -------------------------------------------------------------------------------------- | --------------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-search-input |\n| **visibleDropdown** | false \\| true | The current status of the Search Dropdown. | |\n| **term\\*** | string | Term to be researched. | |\n| **isLoading** | false \\| true | Enables a loading state. | |\n| **terms\\*** | { value: string; }\\[\\] | List of Suggestion terms. | |\n| **products\\*** | {}\\[\\] | List of Suggested products. | |\n| **onSearchSelection** | (term: string, path: string) => void | Callback function when a search term is selected. | |\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/search-input.mdx)\n\n[RegionModal« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-region-modal)[ShippingSimulationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-shipping-simulation)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23props)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/search-input.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-search-input/docs/guides/faststore/organisms-search-input%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input/docs/guides/faststore/organisms-search-input%23props)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_518cb83a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides setting up the type of interest rate in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides)\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/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/setting-up-the-type-of-interest-rate/docs/guides/setting-up-the-type-of-interest-rate)\n\nSetting up the type of interest rate\n\n## Identifying the payment method's ID\n\nThe payment method's ID can be configured to have Simple Interest Rates and is obtained by following these steps:\n\n1. Access the **Admin VTEX**.\n2. Click on **Payments**.\n3. Then, click on **Settings**.\n4. In **Payment Conditions** tab, select the payment condition that should be configured to use Simple Interest Rates.\n5. Copy the last URL parameter, which shows the ID of this Payment Method (see image).\n\n\n\n## Setting up the interest rate type using API\n\nThe `interestRateMethod` field is where the setup should be implemented, if we were to use the Simple Interest Rate or Compound Interest Rate calculation algorithm:\n\n* **Simple Interest Rate** will equal `interestRateMethod`: 1.\n* **Compound Interest Rate** will equal `interestRateMethod`: null.\n\nA `GET Rule by ID` call will initially be sent in order to receive the updated Payment Method setting through the following API:\n\n* [rulebyid](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/rulebyid)\n\nThe reply that the `GET Rule by ID` call returns will be the request of the thereafter `POST Rule by ID` call. To save the new configuration, only the value `interestRateMethod`:1 should be modified:\n\n* [putrulebyid](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/putrulebyid)\n\n> At present, the only way to change a payment method is through API. Should it be necessary to change the payment method by using the user interface, the setup process through API would have to be repeated, since when saving the changes, the value will be considered empty by default.\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/Payments/payments-configuration-guides/setting-up-the-type-of-interest-rate.md)\n\n[Configuration Guides« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate//docs/guides/payments-configuration-guides)[Setting up Merchant ID in Apple PayNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate//docs/guides/setting-up-merchant-id-in-apple-pay)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Identifying the payment method's ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/setting-up-the-type-of-interest-rate%23identifying-the-payment-methods-id)\n\n[Setting up the interest rate type using API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/setting-up-the-type-of-interest-rate%23setting-up-the-interest-rate-type-using-api)\n\nWas this helpful?\n\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/setting-up-the-type-of-interest-rate.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Identifying the payment method's ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/setting-up-the-type-of-interest-rate%23identifying-the-payment-methods-id)\n\n[Setting up the interest rate type using API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate/docs/guides/setting-up-the-type-of-interest-rate%23setting-up-the-interest-rate-type-using-api)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_65095d23
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides create a regular order from an existing cart in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/orders-2)\n\n[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-with-the-checkout-api)\n\n[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/orders-2)\n\n[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-with-the-checkout-api)\n\n[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-api-overview)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/orders-2)\n\n[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart)\n\nCreating a regular order from an existing cart\n\nLearn how to use VTEX APIs to place a regular order from an existing cart.\n\nThis step-by-step guide will walk you through the process of using the [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) and [Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) to create an order from an existing shopping cart. It is divided into the following steps:\n\n1. **Get cart information:** Begin by retrieving the `orderFormId` of the current shopping cart via the [Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm) endpoint.\n2. **Place the order:** Continue by placing the order on the VTEX platform via the [Place order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/transaction) endpoint.\n3. **Handling the order payment and processing:** The process ends by [sending the necessary payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api%23post-/api/pub/transactions/-transactionId-/payments) to resolve the order payment and by [processing order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/gatewayCallback/-orderGroup-).\n\n## Before you begin\n\nBefore proceeding any further, ensure that you have a valid `appKey` and `appToken` with the necessary permissions to access the [Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) and [Payments Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) APIs. For more information, refer to the [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) article.\n\n## Preparing the cart\n\nIn addition to valid credentials, ensure that the cart used to create the order already includes all the required information. Without these details, the steps described in this guide cannot be completed:\n\n* **Selected products**: Ensure the cart includes the desired items.\n* **Customer data and shipping address**: Confirm that the information is complete and valid.\n* **Payment method**: Define the payment option in advance. For credit cards, also include the number of installments and the card brand.\n\nAll of these details can be easily verified on the checkout screen, as shown in the illustration below.\n\n\n\n> Click the steps below to navigate through this article and explore specific topics. Relevant code for each phase or parameter is highlighted on the right side of the screen.\n\n## Step 1 - Getting cart information\n\nSend a `GET` request to the [Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm) endpoint to retrieve the `orderFormId` of the shopping cart you intend to use to create an order. The `orderFormId` is a unique identifier for the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) linked to a specific shopping cart.\n\n> For more information, refer to the [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id) guide.\n\n## Step 2 - Placing the order\n\nPlace a new order via the [Place order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/transaction) endpoint, using the shopping cart identification (`orderFormId`) as a path parameter and providing the following information in the request body:\n\n* `referenceId`: the same `orderFormId` value used in the path parameter.\n* `value`: total value of the order in cents (e.g., $24.99 is represented by `2499`).\n* `referenceValue`: reference value of the order in cents (e.g., $24.99 is represented by `2499`). This is used for calculating interest, if applicable.\n* `interestValue`: interest value to be applied, if applicable.\n* `savePersonalData`: set as `true` if the shopper's data provided during checkout should be saved for future reference (default is `false`).\n* `optinNewsLetter`: set as `true` if the shopper opted to receive the newsletter (default is `false`).\n\nUpon receiving a `200 OK` response, the request will provide a response body containing the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) with comprehensive details of the newly created regular order. Note the following details. Then, proceed to [Resolving the order payment](#step-3---resolving-the-order-payment).\n\n* `orderGroup` \\- ID that groups all orders related to the same purchase. For example, when an order is fulfilled by multiple sellers, each seller has its own order ID (`v71021570str-01` and `v71021570str-02`), but they share the same order group ID (`v71021570str`).\n* `transactionId` \\- ID of the transaction, which can be found within an object contained in the `merchantTransactions` array.\n\n> If you encounter errors during the request submission, refer to [Handling HTTP response errors when placing the order](#handling-http-response-errors-when-placing-the-order) for common error scenarios when placing an order.\n\n## Step 3 - Resolving the order payment\n\nNow, we will communicate the necessary payment data to VTEX to finalize the order payment.\n\n> Note that from now on (once Step 2 has been completed), you have 5 minutes to submit the payment information (Step 3) and process the order (Step 4). If Steps 3 and 4 are not completed within 5 minutes, the order will be automatically canceled.\n\n* Send a request to the [Send payments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api%23post-/api/pub/transactions/-transactionId-/payments) endpoint, considering the following: \n * Use the `transactionId` value from the previous step as both the path parameter and the value for the `id` field within the `transaction` object. \n * Set the `merchantName` field within the `transaction` object to your account name. \n * Use the `orderId` value as a query string parameter. This is the same `orderGroup` obtained in the previous step. \n * Ensure that the request body is based on the `paymentData` section of your `orderForm`. \n * In the `fields` object, you can: \n * Fill in the credit or debit card information (when applicable). \n * Use the `addressId` field to reference an existing address, or provide a new `address` object for an entirely new address. This type of information is only required if the shopper's address was not previously entered during checkout.\n\n> This request does not return any data in the response body, only a `201 Created` success confirmation message.\n\n## Step 4 - Processing and validating the order\n\nIn this final step, we will process the order.\n\n* Send a request to the [Process order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/gatewayCallback/-orderGroup-) endpoint, using the `orderGroup` value (which is the `orderFormId`) as a path parameter.\n\n> If the payment is processed without any issues, the order should be successfully placed (`204 No Content` status). Otherwise, a `500 Internal Server Error` message might occur.\n\n> Note that this process uses the gateway connectors configured in your VTEX environment. Be careful to prevent any unwanted charges or unexpected payment denials.\n\nShell\n\nPython\n\nNode.js\n\n`1\n\ncurl --request get \\ \n\n2\n\n --url https://apiexamples.vtexcommercestable.com.br/api/checkout/pub/orderForm \\ \n\n3\n\n --header 'Accept: application/json' \\ \n\n4\n\n --header 'Content-Type: application/json' \n\n`\n\nResponse\n\n`1\n\n{ \n\n2\n\n \"orderFormId\": \"9563daa04ee24ac09be80d272dcc9e72\", \n\n3\n\n \"salesChannel\": \"1\", \n\n4\n\n \"loggedIn\": false, \n\n5\n\n \"isCheckedIn\": false, \n\n6\n\n \"storeId\": null, \n\n7\n\n \"checkedInPickupPointId\": null, \n\n8\n\n \"allowManualPrice\": false, \n\n9\n\n \"canEditData\": true, \n\n10\n\n \"userProfileId\": \"string\", \n\n11\n\n \"userType\": null, \n\n12\n\n \"ignoreProfileData\": false, \n\n13\n\n \"value\": 30000, \n\n14\n\n \"messages\": [], \n\n15\n\n \"items\": [ \n\n16\n\n { \n\n17\n\n \"uniqueId\": \"07FA7060463B48B7A8761E72C763DCE4\", \n\n18\n\n \"id\": \"102\", \n\n19\n\n \"productId\": \"11\", \n\n20\n\n \"productRefId\": \"00011\", \n\n21\n\n \"refId\": \"00012\", \n\n22\n\n \"ean\": null, \n\n23\n\n \"name\": \"Adidas x South Park Forum Low “AWESOM-O” caramel 38\", \n\n24\n\n \"skuName\": \"Adidas x South Park Forum Low “AWESOM-O” caramel 38\", \n\n25\n\n \"modalType\": null, \n\n26\n\n \"parentItemIndex\": null, \n\n27\n\n \"parentAssemblyBinding\": null, \n\n28\n\n \"assemblies\": [], \n\n29\n\n \"priceValidUntil\": \"2026-09-22T22:02:39Z\", \n\n30\n\n \"tax\": 0, \n\n31\n\n \"price\": 30000, \n\n32\n\n \"listPrice\": 30000, \n\n33\n\n \"manualPrice\": null, \n\n34\n\n \"manualPriceAppliedBy\": null, \n\n35\n\n \"sellingPrice\": 30000, \n\n36\n\n \"rewardValue\": 0, \n\n37\n\n \"isGift\": false, \n\n38\n\n \"additionalInfo\": { \n\n39\n\n \"dimension\": null, \n\n40\n\n \"brandName\": \"VTEX Brand\", \n\n41\n\n \"brandId\": \"2000002\", \n\n42\n\n \"offeringInfo\": null, \n\n43\n\n \"offeringType\": null, \n\n44\n\n \"offeringTypeId\": null \n\n45\n\n }, \n\n46\n\n \"preSaleDate\": null, \n\n47\n\n \"productCategoryIds\": \"/2000017/\", \n\n48\n\n \"productCategories\": { \n\n49\n\n \"2000017\": \"VTEX Day Hackthon\" \n\n50\n\n }, \n\n51\n\n \"quantity\": 1, \n\n52\n\n \"seller\": \"1\", \n\n53\n\n \"sellerChain\": [ \n\n54\n\n \"1\" \n\n55\n\n ], \n\n56\n\n \"imageUrl\": \"https://accountname.vteximg.com.br/arquivos/ids/155427-55-55/gy6475-1.jpg?v=638418000550100000\", \n\n57\n\n \"detailUrl\": \"/adidas-southpark-awesome/p\", \n\n58\n\n \"components\": [], \n\n59\n\n \"bundleItems\": [], \n\n60\n\n \"attachments\": [], \n\n61\n\n \"attachmentOfferings\": [], \n\n62\n\n \"offerings\": [], \n\n63\n\n \"priceTags\": [], \n\n64\n\n \"availability\": \"available\", \n\n65\n\n \"measurementUnit\": \"un\", \n\n66\n\n \"unitMultiplier\": 1.0000, \n\n67\n\n \"manufacturerCode\": null, \n\n68\n\n \"priceDefinition\": { \n\n69\n\n \"calculatedSellingPrice\": 30000, \n\n70\n\n \"total\": 2200, \n\n71\n\n \"sellingPrices\": [ \n\n72\n\n { \n\n73\n\n \"value\": 30000, \n\n74\n\n \"quantity\": 1 \n\n75\n\n } \n\n76\n\n ], \n\n77\n\n \"reason\": null \n\n78\n\n }, \n\n79\n\n \"taxCode\": \"\" \n\n80\n\n } \n\n81\n\n ], \n\n82\n\n \"selectableGifts\": [], \n\n83\n\n \"totalizers\": [ \n\n84\n\n { \n\n85\n\n \"id\": \"Items\", \n\n86\n\n \"name\": \"Total dos Itens\", \n\n87\n\n \"value\": 30000 \n\n88\n\n }, \n\n89\n\n { \n\n90\n\n \"id\": \"Shipping\", \n\n91\n\n \"name\": \"Total do Frete\", \n\n92\n\n \"value\": 0 \n\n93\n\n } \n\n94\n\n ], \n\n95\n\n \"shippingData\": { \n\n96\n\n \"address\": {}, \n\n97\n\n \"logisticsInfo\": [], \n\n98\n\n \"selectedAddresses\": [], \n\n99\n\n \"availableAddresses\": [], \n\n100\n\n \"pickupPoints\": [], \n\n101\n\n \"contactInformation\": [] \n\n102\n\n }, \n\n103\n\n \"clientProfileData\": { \n\n104\n\n \"email\": \"name.surname@test.com\", \n\n105\n\n \"firstName\": \"Name\", \n\n106\n\n \"lastName\": \"Surname\", \n\n107\n\n \"document\": \"5555555555\", \n\n108\n\n \"documentType\": \"cpf\", \n\n109\n\n \"phone\": \"+55125555555\", \n\n110\n\n \"corporateName\": null, \n\n111\n\n \"tradeName\": null, \n\n112\n\n \"corporateDocument\": null, \n\n113\n\n \"stateInscription\": null, \n\n114\n\n \"corporatePhone\": null, \n\n115\n\n \"isCorporate\": false, \n\n116\n\n \"profileCompleteOnLoading\": null, \n\n117\n\n \"profileErrorOnLoading\": null, \n\n118\n\n \"customerClass\": null \n\n119\n\n }, \n\n120\n\n \"paymentData\": { \n\n121\n\n \"updateStatus\": \"updated\", \n\n122\n\n \"installmentOptions\": [ \n\n123\n\n { \n\n124\n\n \"paymentSystem\": \"1\", \n\n125\n\n \"bin\": null, \n\n126\n\n \"paymentName\": null, \n\n127\n\n \"paymentGroupName\": null, \n\n128\n\n \"value\": 30000, \n\n129\n\n \"installments\": [ \n\n130\n\n { \n\n131\n\n \"count\": 1, \n\n132\n\n \"hasInterestRate\": false, \n\n133\n\n \"interestRate\": 0, \n\n134\n\n \"value\": 30000, \n\n135\n\n \"total\": 30000, \n\n136\n\n \"sellerMerchantInstallments\": [ \n\n137\n\n { \n\n138\n\n \"id\": \"accountName\", \n\n139\n\n \"count\": 1, \n\n140\n\n \"hasInterestRate\": false, \n\n141\n\n \"interestRate\": 0, \n\n142\n\n \"value\": 30000, \n\n143\n\n \"total\": 30000 \n\n144\n\n } \n\n145\n\n ] \n\n146\n\n }, \n\n147\n\n { \n\n148\n\n \"count\": 2, \n\n149\n\n \"hasInterestRate\": true, \n\n150\n\n \"interestRate\": 200, \n\n151\n\n \"value\": 15451, \n\n152\n\n \"total\": 30902, \n\n153\n\n \"sellerMerchantInstallments\": [ \n\n154\n\n { \n\n155\n\n \"id\": \"accountName\", \n\n156\n\n \"count\": 2, \n\n157\n\n \"hasInterestRate\": true, \n\n158\n\n \"interestRate\": 200, \n\n159\n\n \"value\": 15451, \n\n160\n\n \"total\": 30902 \n\n161\n\n } \n\n162\n\n ] \n\n163\n\n }, \n\n164\n\n ... \n\n165\n\n ] \n\n166\n\n } \n\n167\n\n ], \n\n168\n\n \"paymentSystems\": [ \n\n169\n\n \"paymentSystems\": [ \n\n170\n\n { \n\n171\n\n \"id\": 64, \n\n172\n\n \"name\": \"Customer Credit\", \n\n173\n\n \"groupName\": \"creditControlPaymentGroup\", \n\n174\n\n \"validator\": { \n\n175\n\n \"regex\": null, \n\n176\n\n \"mask\": null, \n\n177\n\n \"cardCodeRegex\": null, \n\n178\n\n \"cardCodeMask\": null, \n\n179\n\n \"weights\": null, \n\n180\n\n \"useCvv\": false, \n\n181\n\n \"useExpirationDate\": false, \n\n182\n\n \"useCardHolderName\": false, \n\n183\n\n \"useBillingAddress\": false \n\n184\n\n }, \n\n185\n\n ... \n\n186\n\n } \n\n187\n\n ] \n\n188\n\n ], \n\n189\n\n \"payments\": [ \n\n190\n\n { \n\n191\n\n \"paymentSystem\": \"2\", \n\n192\n\n \"bin\": null, \n\n193\n\n \"accountId\": null, \n\n194\n\n \"tokenId\": null, \n\n195\n\n \"installments\": 1, \n\n196\n\n \"referenceValue\": 30000, \n\n197\n\n \"value\": 30000, \n\n198\n\n \"merchantSellerPayments\": [ \n\n199\n\n { \n\n200\n\n \"id\": \"accountName\", \n\n201\n\n \"installments\": 1, \n\n202\n\n \"referenceValue\": 30000, \n\n203\n\n \"value\": 30000, \n\n204\n\n \"interestRate\": null, \n\n205\n\n \"installmentValue\": 30000 \n\n206\n\n } \n\n207\n\n ] \n\n208\n\n } \n\n209\n\n ], \n\n210\n\n \"giftCards\": [], \n\n211\n\n \"giftCardMessages\": [], \n\n212\n\n \"availableAccounts\": [], \n\n213\n\n \"availableTokens\": [] \n\n214\n\n }, \n\n215\n\n \"marketingData\": null, \n\n216\n\n \"sellers\": [ \n\n217\n\n { \n\n218\n\n \"id\": \"1\", \n\n219\n\n \"name\": \"accountName\", \n\n220\n\n \"logo\": \"\", \n\n221\n\n \"minimumOrderValue\": 0 \n\n222\n\n } \n\n223\n\n ], \n\n224\n\n \"clientPreferencesData\": { \n\n225\n\n \"locale\": \"pt-BR\", \n\n226\n\n \"optinNewsLetter\": null \n\n227\n\n }, \n\n228\n\n \"commercialConditionData\": null, \n\n229\n\n \"storePreferencesData\": { \n\n230\n\n \"countryCode\": \"BRA\", \n\n231\n\n \"saveUserData\": true, \n\n232\n\n \"timeZone\": \"E. South America Standard Time\", \n\n233\n\n \"currencyCode\": \"BRL\", \n\n234\n\n \"currencyLocale\": 1046, \n\n235\n\n \"currencySymbol\": \"R$\", \n\n236\n\n \"currencyFormatInfo\": { \n\n237\n\n \"currencyDecimalDigits\": 2, \n\n238\n\n \"currencyDecimalSeparator\": \",\", \n\n239\n\n \"currencyGroupSeparator\": \".\", \n\n240\n\n \"currencyGroupSize\": 3, \n\n241\n\n \"startsWithCurrencySymbol\": true \n\n242\n\n } \n\n243\n\n }, \n\n244\n\n \"giftRegistryData\": null, \n\n245\n\n \"openTextField\": null, \n\n246\n\n \"invoiceData\": null, \n\n247\n\n \"customData\": null, \n\n248\n\n \"itemMetadata\": { \n\n249\n\n \"items\": [ \n\n250\n\n { \n\n251\n\n \"id\": \"102\", \n\n252\n\n \"seller\": \"1\", \n\n253\n\n \"name\": \"Adidas x South Park Forum Low “AWESOM-O” caramel 38\", \n\n254\n\n \"skuName\": \"Adidas x South Park Forum Low “AWESOM-O” caramel 38\", \n\n255\n\n \"productId\": \"11\", \n\n256\n\n \"refId\": \"00012\", \n\n257\n\n \"ean\": null, \n\n258\n\n \"imageUrl\": \"https://accountname.vteximg.com.br/arquivos/ids/155427-55-55/gy6475-1.jpg?v=638418000550100000\", \n\n259\n\n \"detailUrl\": \"/adidas-southpark-awesome/p\", \n\n260\n\n \"assemblyOptions\": [] \n\n261\n\n } \n\n262\n\n ] \n\n263\n\n }, \n\n264\n\n \"hooksData\": null, \n\n265\n\n \"ratesAndBenefitsData\": null, \n\n266\n\n \"subscriptionData\": null, \n\n267\n\n \"itemsOrdination\": null \n\n268\n\n} \n\n`\n\n## Handling HTTP response errors when placing the order\n\n### 400 - Bad Request (`ORD002`)\n\n`Message error example (code ORD002): \"Invalid order form\"`\n\n* **Issue:** The `orderFormId` information is not valid.\n* **Troubleshooting:** \n * Verify that the `orderFormId` is correct. \n * Ensure that the `orderFormId` corresponds to an existing shopping cart.\n\n### 400 - Bad Request (`CHK0016`)\n\n`Message error example (code CHK0016): \"Payment value does not match with reference value\"`\n\n* **Issue:** The `value` and `referenceValue` fields have different values even when no interest is applied to the payment.\n* **Troubleshooting:** \n * Confirm that the provided `value` and `referenceValue` align correctly. \n * Check if the interest rate is correctly configured.\n\n### 404 - Not Found\n\n`Message error example: \"The requested URL was not found on the server\"`\n\n* **Issue:** The requested URL was not found on the server.\n* **Troubleshooting:** Check if the endpoint used is correct.\n\n### 500 - Internal Server Error\n\n`Message error example (code ORD005): \"The purchase cannot be done without items\"`\n\n* **Issue:** The shopping cart (`orderFormId`) informed in the request does not have any item, making it impossible to create an order.\n* **Troubleshooting:** \n * Verify that the specified shopping cart has items. \n * Confirm that the `orderFormId` corresponds to a valid and non-empty shopping cart.\n\nResponse\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD002\", \n\n5\n\n \"message\": \"Invalid order form\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"f01ef909-8b81-4ffd-a91d-82be680d60ff\" \n\n9\n\n} \n\n`\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/creating-a-regular-order-from-an-existing-cart.mdx)\n\n[Creating a regular order with the Checkout API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart//docs/guides/creating-a-regular-order-with-the-checkout-api)[SecurityNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart//docs/guides/checkout-security)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\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/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23before-you-begin)\n\n[Preparing the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23preparing-the-cart)\n\n[Step 1 - Getting cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-1-getting-cart-information)\n\n[Step 2 - Placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-2-placing-the-order)\n\n[Step 3 - Resolving the order payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-3-resolving-the-order-payment)\n\n[Step 4 - Processing and validating the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-4-processing-and-validating-the-order)\n\n[Handling HTTP response errors when placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23handling-http-response-errors-when-placing-the-order)\n\n[400 - Bad Request (ORD002)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23400-bad-request-ord002)[400 - Bad Request (CHK0016)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23400-bad-request-chk0016)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23404-not-found)[500 - Internal Server Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23500-internal-server-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/Checkout/creating-a-regular-order-from-an-existing-cart.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/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23before-you-begin)\n\n[Preparing the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23preparing-the-cart)\n\n[Step 1 - Getting cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-1-getting-cart-information)\n\n[Step 2 - Placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-2-placing-the-order)\n\n[Step 3 - Resolving the order payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-3-resolving-the-order-payment)\n\n[Step 4 - Processing and validating the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-4-processing-and-validating-the-order)\n\n[Handling HTTP response errors when placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23handling-http-response-errors-when-placing-the-order)\n\n[400 - Bad Request (ORD002)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23400-bad-request-ord002)[400 - Bad Request (CHK0016)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23400-bad-request-chk0016)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23404-not-found)[500 - Internal Server Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23500-internal-server-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_25df010c
|
[
{
"role": "system",
"content": "You are a VTEX 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 how it 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/master-data-how-it-works/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-how-it-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/master-data-how-it-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/master-data-how-it-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/master-data-how-it-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/master-data-how-it-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/master-data-how-it-works/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/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-how-it-works/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/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-how-it-works/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/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-how-it-works/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/understanding-master-data)\n\n[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-components)\n\n[Master Data infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-infrastructure)\n\n[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/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-how-it-works/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-how-it-works/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-how-it-works/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/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-how-it-works/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-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/master-data-how-it-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/master-data-how-it-works/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/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-how-it-works/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/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-how-it-works/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/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-how-it-works/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/understanding-master-data)\n\n[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-components)\n\n[Master Data infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-infrastructure)\n\n[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/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-how-it-works/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-how-it-works/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-how-it-works/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/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-how-it-works/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-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/master-data-how-it-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/master-data-how-it-works/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/understanding-master-data)\n\nUnderstanding Master Data\n\nLearn about the fundamental concepts of Master Data, including its components, architecture, API usage, and schema lifecycle.\n\n[ComponentsLearn about Data Entities, Documents, Fields, and Indexes in Master Data, and how these components work together to structure and optimize data for efficient querying.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components)[InfrastructureLearn how the Master Data core services (API, Worker, Storage, and Search Engine) ensure data consistency and efficient document management.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-infrastructure)[Master Data APILearn how to manage and retrieve documents, define data structures, and configure searchable fields in Master Data.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-schema-lifecycle)[Data consistency and synchronization in Master DataLearn how data synchronization operates across Master Data API endpoints.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-consistency-and-synchronization-in-master-data)[Schema LifecycleLearn how changes in a Master Data v2 Schema affect Data Entities.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-schema-lifecycle)\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/understanding-master-data.md)\n\n[Master Data« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works//docs/guides/master-data)[Master Data componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works//docs/guides/master-data-components)\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/understanding-master-data/understanding-master-data.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_33e5b3a1
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting i cant install the headless cms plugins in my account in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/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/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting)\n\nDevelopment\n\nI can’t install the Headless CMS plugins in my account\n\nUsers may encounter errors related to symbolic links and node version incompatibility.\n\nFastStore users may encounter the following errors after [installing the Headless CMS plugin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account%23step-1-setting-up-the-command-line-environment).\n\n| Error message | Possible cause | Solution |\n| ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Error: EPERM: operation not permitted, symlink | Your device isn’t enabled for development. | [Enable Developer Mode in your machine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/error-installing-headless-cms-plugins-on-windows%23enable-developer-mode-in-your-machine) |\n| error @oclif/core@1.26.2: The engine \"node\" is incompatible with this module. Expected version \">=14.0.0\". Got \"12.12.0\" | The VTEX IO CLI’s node version isn’t updated. Expected version was \\>=14.0.0, but the current version is 12.12.0. | [Update VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/error-installing-headless-cms-plugins-on-windows%23update-vtex-io-cli) |\n\n## Solutions\n\nTo solve these issues, follow the instructions below:\n\n* [Enable Developer Mode on your machine](#enable-developer-mode-on-your-machine)\n* [Update VTEX IO CLI](#update-vtex-io-cli)\n\n### Enable Developer Mode on your machine\n\nWhile running the `vtex plugins install cms`, Windows users can get the following error:\n\n`1\n\nvtex plugins install cms \n\n2\n\nwarning \"@vtex/cli-plugin-cms > @vtex/api > apollo-server-core > apollo-graphql@0.9.5\" has incorrect peer dependency \"graphql@^14.2.1 || ^15.0.0\". \n\n3\n\nInstalling plugin @vtex/cli-plugin-cms... failed \n\n4\n\n Error: EPERM: operation not permitted, symlink \n\n5\n\n 'C:\\Users\\LukeSkywalker\\AppData\\Roaming\\npm\\node_modules\\vtex' -> \n\n6\n\n 'C:\\Users\\LukeSkywalker\\AppData\\Local\\vtex\\node_modules\\vtex' \n\n7\n\n Code: EPERM \n\n`\n\nFastStore projects rely on creating symbolic links (symlinks). To solve this error, you must enable [Developer Mode](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development%23accessing-settings-for-developers) on your machine. Developer Mode grants the necessary permissions and privileges to use symlinks, which reduces the probability of encountering errors during development.\n\n> Running the FastStore project as an administrator isn't recommended.\n\nLearn how to enable Developer Mode in Microsoft's official guide [Enable your device for development](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development%23accessing-settings-for-developers).\n\nAfter enabling Developer Mode, launch Windows Terminal and run `vtex cms`. This will allow the system to create the necessary symlinks for running commands from the Headless CMS plugin.\n\n### Update VTEX IO CLI\n\nIf you run the `vtex plugins install cms` command and get the error below, you need to update the VTEX IO CLI version you're using.\n\n`1\n\nvtex plugins install cms \n\n2\n\nerror @oclif/core@1.26.2: The engine \"node\" is incompatible with this module. Expected version \">=14.0.0\". Got \"12.12.0\" \n\n3\n\nerror Found incompatible module. \n\n4\n\nInstalling plugin @vtex/cli-plugin-cms... failed \n\n5\n\n Error: yarn add @vtex/cli-plugin-cms@latest --non-interactive --mutex=file:C:\\Users\\barbara.celi\\AppData\\Local\\vtex\\yarn.lock --preferred-cach \n\n`\n\nEven if you update the `node` version on your machine, you must also keep VTEX IO CLI updated to avoid errors.\n\nTo update VTEX IO CLI, open Windows Terminal and follow these instructions:\n\n1. Run the `vtex autoupdate` command in Windows Terminal.\n2. Run the `vtex -v` command to check if the VTEX IO CLI and `node` versions are updated.\n3. Run the `vtex plugins install cms` command to install the Headless CMS plugins.\n4. Check if the installation of Headless CMS plugins was successful by running `vtex cms`. You should see the following:\n\n`1\n\n$ vtex cms \n\n2\n\nSyncs CMS schemas with the current workspace in use. \n\n3\n\n \n4\n\nUSAGE \n\n5\n\n $ vtex cms COMMAND \n\n6\n\nCOMMANDS \n\n7\n\n cms sync Syncs CMS schemas with the current workspace in use. \n\n`\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-install-the-headless-cms-plugins-in-my-account.md)\n\n[I can’t access the Headless CMS« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/unable-to-access-headless-cms)[I can't install VTEX IO CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23solutions)\n\n[Enable Developer Mode on your machine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23enable-developer-mode-on-your-machine)[Update VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23update-vtex-io-cli)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-install-the-headless-cms-plugins-in-my-account.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23solutions)\n\n[Enable Developer Mode on your machine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23enable-developer-mode-on-your-machine)[Update VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23update-vtex-io-cli)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_5365b0f0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides enable the manual price in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/features)\n\n[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price)\n\n[Enable the Save user data opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-save-user-data-opt-in)\n\n[Enable the Region for SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-region-for-skus)\n\n[Configure the Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/configure-the-global-checkout)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/features)\n\n[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price)\n\n[Enable the Save user data opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-save-user-data-opt-in)\n\n[Enable the Region for SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-region-for-skus)\n\n[Configure the Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/configure-the-global-checkout)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-api-overview)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/features)\n\n[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price)\n\nEnable the Manual Price\n\nAt VTEX, stores can manually set the price of an item ([SKU](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/o-que-e-um-sku--1K75s4RXAQyOuGUYKMM68u%23)) when it is in the cart, on the product page on [inStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/allow-manual-prices-on-instore), or is a subscription item. This feature is called **Manual Price** and can only be performed by some Admin VTEX user profiles.\n\nBefore starting to manually set prices in your store, the following information should be considered:\n\n* Item prices can be modified (increased/decreased) freely, without any kind of restriction. However, if the price is changed to a value that is outside the parameters defined in the [Order Authorization](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/how-order-authorization-works--3MBK6CmKHAuUjMBieDU0pn%23) feature, the order will not be invoiced.\n* Users with the following roles or permission will have access to modify the price of all items registered to your account (including all stores/sub-accounts): \n * **Roles**: Owner (Admin Super) or Call Center Operator (Telesales) \n * **Permission**: Shopping Cart Full Access\n\n## Manual Price activation\n\nTo use the Manual Price functionality in your store, you must first enable it. Then, follow the settings 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 value of the `allowManualPrice` parameter from `null` to `true`.\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\n## Setting the price of an item manually\n\nFor each sales method, there is a different way of manually modifying the price. The list below describes the procedure for each of these methods:\n\n* **Cart items:** making a `PUT` request using the endpoint [Change Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/pricechange), or configuring directly on the shop cart screen, check [Change the price of an item in the shopping cart](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/modificar-o-preco-de-um-item-no-carrinho-de-compras--7Cd37aCAmtL1qmoZJJvjNf).\n* **inStore items:** check [Allow manual prices on inStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/allow-manual-prices-on-instore%23usage).\n* **Subscription items:** check [Enabling Manual Prices for Subscriptions v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enabling-manual-prices-for-subscriptions-v3).\n\n## Recording manual changes to item prices\n\nAll price changes made manually are recorded and the user responsible for the change can be identified. To verify the user responsible for modifying the price of an item, follow the steps below:\n\n1. Makes a `GET` request using the endpoint [Get Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorder). You will need to provide the specific `orderId` on which the price was manually modified.\n2. Register the information available in the `manualPriceAppliedBy` property. It will bring up the _user ID_ or the _appKey_ used to make the change.\n3. Makes a `GET` request using the endpoint [License Manager - Get User](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/reference/getuser), filling in with the _user ID_ or _appKey_, to obtain the data of the person responsible for the modification.\n\nExample of information available in `manualPriceAppliedBy` property:\n\n\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/features/enable-the-manual-price.md)\n\n[Features« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price//docs/guides/features)[Enable the Save user data opt-inNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price//docs/guides/enable-the-save-user-data-opt-in)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Manual Price activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23manual-price-activation)\n\n[Setting the price of an item manually](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23setting-the-price-of-an-item-manually)\n\n[Recording manual changes to item prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23recording-manual-changes-to-item-prices)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/features/enable-the-manual-price.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Manual Price activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23manual-price-activation)\n\n[Setting the price of an item manually](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23setting-the-price-of-an-item-manually)\n\n[Recording manual changes to item prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23recording-manual-changes-to-item-prices)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_7184161b
|
[
{
"role": "system",
"content": "You are a VTEX 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 platform 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/vtex-platform-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-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/vtex-platform-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/vtex-platform-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/vtex-platform-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/vtex-platform-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/vtex-platform-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/composability)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-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/vtex-platform-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-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/vtex-platform-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/vtex-platform-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/composability)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-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/vtex-platform-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-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/vtex-platform-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/vtex-platform-overview/docs/guides)\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/vtex-platform-overview)\n\nVTEX Platform Overview\n\nDiscover how our engineering decisions can benefit your business with the VTEX Platform Overview documentation.\n\nThis collection of guides provides a comprehensive overview of our platform, highlighting key technical aspects that can empower your team and drive your business forward.\n\nExplore the following guides to discover how VTEX can meet your business requirements and support your goals, whether you are exploring new solutions or looking to optimize your existing setup.\n\n[Cloud infrastructureLearn how our infrastructure decisions ensure scalability, reliability, and performance for your business.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cloud-infrastructure)[SecurityDiscover the robust security measures and best practices we implement to protect your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/security)[Data privacyLearn about our commitment to data privacy and how we ensure compliance to safeguard personal data.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-privacy)[ComposabilityExplore how our platform's composability enables you to build tailored solutions that fit your unique business needs.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability)[ExtensibilityUnderstand how to extend VTEX capabilities beyond what comes out of the box.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility)[Store architectureDive into store architecture models within our platform that are tailored to various business needs.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-architecture)[Developer experienceDiscover how our platform enhances the developer experience, making it easy for your team to build and deploy applications.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience)\n\n## Other resources\n\n[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)\n\nThe Help Center contains beginner tutorials, reference guides, and troubleshooting articles about the VTEX Admin panel.\n\n[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)\n\nVTEX Community is an ecosystem where our clients and partners can interact, ask questions, and exchange information among themselves. It is the go-to place to find answers and talk about VTEX products.\n\n[Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support)\n\nAll customers have access to the services provided by our Technical Support team. These specialists are extensively prepared to give you the best experience possible when solving your tickets. To contact them, you need to open a ticket with VTEX support.\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-Platform-Overview/vtex-platform-overview.md)\n\n[Cloud infrastructureNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview//docs/guides/cloud-infrastructure)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Other resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/vtex-platform-overview%23other-resources)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Platform-Overview/vtex-platform-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Other resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview/docs/guides/vtex-platform-overview%23other-resources)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_794d1657
|
[
{
"role": "system",
"content": "You are a VTEX 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 workspaces best practices in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/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-workspaces-best-practices/docs/app-development)\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspace)\n\n[Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices)\n\nBest practices on workspaces management\n\nLearn how to manage workspaces effectively.\n\nCheck out the following [workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) guidelines to ensure smooth development, effective testing, secure deployments, and minimal errors and breakdowns.\n\n## Workspace setup\n\nUnderstanding workspaces is essential for effective development. Different types of workspaces, such as Development and Production, serve specific purposes and should be used properly.\n\n* **Using development workspaces**: Create a separate [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/) and switch to it before starting any development work. Note that making changes directly to the master workspace can potentially affect the user experience.\n* **\\[Store Framework\\] Developing a Store Theme**: Before developing a Store Theme app, make sure the [Store Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) is installed in your account. Otherwise, you won't be able to use Store Framework successfully.\n* **App vendor**: Developing a Store Theme or other apps using [subaccounts](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-subaccount-multi-store-multi-domain--tutorials%5F510?%26utm%5Fsource=autocomplete) is not recommended. This practice may lead to inconsistencies that will make it impossible to install the app in the production workspace of the main account. Always use a **development workspace** derived from the main account for such tasks.\n\n## Managing collaborative projects\n\nIn collaborative projects that involve different workspaces, be mindful of the **development workspace** you are using and ensure that code versioning is applied using appropriate tools, such as GitHub.\n\n* **Using workspaces**: Never develop apps directly in the production workspace. This may break your store when the app is promoted to master.\n* **Code versioning**: Use efficient code versioning practices to make sure changes can be tracked. This makes it easier to identify issues and revert changes if necessary. Use pull requests for proposing and reviewing changes, ensuring documentation and discussion to maintain quality standards.\n\n## Testing and quality assurance\n\nFrom pre-production testing to implementing A/B testing strategies, learn how to maintain high standards of quality assurance throughout your development process.\n\n* **Pre-production testing**: Before moving any changes to the production workspace, test your code in the development workspace and ensure all features are working as expected.\n* **Production testing**: Once you are satisfied with your code in the development workspace, release a candidate version of your app. Install and thoroughly test it in a production workspace. [Run A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing) to compare traffic between these workspaces to understand which app version is best for your business needs.\n\n## Deployment and workspace promotion\n\nFollow these best practices to deploy changes and promote workspaces seamlessly, avoiding disruptions to your live store.\n\n* **Checkout UI Custom**: If your store uses the [Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0) app, ensure configurations are published to the new production workspace to avoid losing the Checkout custom Javascript code and styles.\n* **Core services data behavior**: Be careful about changes in the [VTEX Core Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started%23vtex-core-services) via Admin, such as Catalog, Pricing, Promotions, Checkout, and others. Changes made to these services in a specific workspace are reflected across all others, as the workspaces share the same VTEX Core Services.\n* **\\[Store Framework\\] Site Editor behavior**: Note that the **Site Editor** is always linked to the workspace, so changes made in a specific workspace do not reflect in others. The master workspace is the only environment where changes made in Site Editor reflect in the live store.\n* **\\[Store Framework\\] Updating live stores**: When performing a major update on your Store Theme, check the steps outlined in the [Migrating CMS setting after a major theme update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update) guide to avoid loss of content.\n\nThe same `treePath` structure must be maintained in the new major, as changes to it result in a content loss in the Site Editor and potential store breakdown. If you need to change the `treePath` structure, make sure to configure the Site Editor again.\n\n## Dos and Don’ts\n\n| ✅ Do | ❌ Don't |\n| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Create a development workspace to start any development work.When developing a Store Theme, make sure your VTEX account has the Store Edition app installed.Use appropriate tools, such as GitHub, to handle code versioning in your projects.Feel free to perform tests in the Site Editor of your development workspace, as changes will not be reflected in others. | Do not use subaccounts to develop a Store Theme or other apps.Do not start development work in a production workspace.Do not make changes in any module of VTEX Core Services when using a development or production workspace. |\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-workspaces-best-practices.md)\n\n[Workspace behavior with app installations« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices//docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations)[Installing an appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices//docs/guides/vtex-io-documentation-installing-an-app)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Workspace setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices%23workspace-setup)\n\n[Managing collaborative projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices%23managing-collaborative-projects)\n\n[Testing and quality assurance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices%23testing-and-quality-assurance)\n\n[Deployment and workspace promotion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices%23deployment-and-workspace-promotion)\n\n[Dos and Don’ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices%23dos-and-donts)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-workspaces-best-practices.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Workspace setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices%23workspace-setup)\n\n[Managing collaborative projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices%23managing-collaborative-projects)\n\n[Testing and quality assurance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices%23testing-and-quality-assurance)\n\n[Deployment and workspace promotion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices%23deployment-and-workspace-promotion)\n\n[Dos and Don’ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices/docs/guides/vtex-io-documentation-workspaces-best-practices%23dos-and-donts)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_95aba43b
|
[
{
"role": "system",
"content": "You are a VTEX 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 composition in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-composition/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-composition/docs/api-reference)\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-composition/docs/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-composition/docs/storefront-development)\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-composition/docs/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-composition/docs/troubleshooting)\n\n[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-composition/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-composition/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-composition/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/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-composition/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-composition/docs/guides/vtex-io-documentation-composition)\n\n[Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-interface)\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-properties)\n\n[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/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-composition/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-composition/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-composition/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-composition/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-composition/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-composition/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-composition/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-composition/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-composition/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-composition/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/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-composition/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-composition/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-composition/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-composition/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-composition/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/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-composition/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-composition/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/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-composition/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-composition/docs/guides/vtex-io-documentation-composition)\n\n[Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-interface)\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-properties)\n\n[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/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-composition/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-composition/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-composition/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-composition/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-composition/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-composition/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-composition/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-composition/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-composition/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-composition/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/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-composition/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-composition/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-composition/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-composition/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-composition/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/store-framework)\n\nConcepts\n\n[Composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-composition)\n\nComposition\n\nThe composition property in the `interfaces.json` file defines how React components behave and structure themselves when used as blocks in a VTEX Store Theme. Components in VTEX are arranged in a parent-child hierarchy, allowing developers to build flexible and well-organized UI layouts.\n\n> Note: The `composition` property determines how child blocks are organized, not the position of the parent block itself.\n\n## Types of composition\n\nThe `composition` property can be set to one of three types: `blocks`, `children`, or `slots`. Each type offers a different approach for organizing and positioning child components within the parent block.\n\n> Recommendation: For greater flexibility, use the [slots](#slots) composition whenever possible.\n\n### Blocks\n\nThe `blocks` composition is the default method for organizing child blocks. When using this composition, all child blocks must be explicitly listed in a `blocks` array.\n\nThese child blocks have predetermined, fixed positions in the UI that are dictated by the React component’s structure, regardless of their placement in the store theme's `json` file.\n\n#### Example\n\n`1\n\n\"shelf#home\": { \n\n2\n\n \"blocks\": [\"product-summary.shelf\"] \n\n3\n\n}, \n\n`\n\nIn this example, the `product-summary.shelf` block is listed as a child of the `shelf#home` block using the `blocks` composition. This means the `product-summary.shelf` will be positioned in a predetermined location in the UI.\n\n### Children\n\nThe `children` composition allows for more flexibility in determining the order of child blocks. Child blocks are declared in a `children` array, and their order in this array directly controls their positioning on the page.\n\nThe first block in the `children` array will appear first, followed by the others in sequence.\n\n#### Example\n\n`1\n\n\"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-name\", \n\n4\n\n \"product-summary-description\", \n\n5\n\n \"product-summary-image\", \n\n6\n\n \"product-summary-price\", \n\n7\n\n \"product-summary-sku-selector\", \n\n8\n\n \"product-summary-buy-button\" \n\n9\n\n ] \n\n10\n\n}, \n\n`\n\nIn this example, `product-summary.shelf` has several child blocks listed in its `children` array. The order in which these blocks appear in the array determines their position on the page. For example, `product-summary-name` will appear first, followed by `product-summary-description`, and so on.\n\n### Slots\n\nThe `slots` composition is the most flexible option. Instead of listing child blocks in an array, you define them using React props, allowing for more dynamic control of how child blocks are passed to the parent component. Each child block can be assigned a custom prop name, which is defined by the parent block.\n\n> For more information on using slots, refer to the [Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/) guide.\n\n#### Example\n\n`1\n\n{ \n\n2\n\n \"hello-world\": { \n\n3\n\n \"props\": { \n\n4\n\n \"Icon\": \"icon-caret#point-up\" \n\n5\n\n } \n\n6\n\n }, \n\n7\n\n \"icon-caret#point-up\": { \n\n8\n\n \"props\": { \n\n9\n\n \"orientation\": \"up\" \n\n10\n\n } \n\n11\n\n } \n\n12\n\n} \n\n`\n\nIn this example, the `icon-caret#point-up` block is declared as a prop of the `hello-world` block using the `slots` composition. The prop name, `Icon`, is custom-defined by the parent block.\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-composition.md)\n\n[Glossary« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition//docs/guides/store-framework-glossary)[InterfacesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition//docs/guides/vtex-io-documentation-interface)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Types of composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-composition%23types-of-composition)\n\n[Blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-composition%23blocks)[Children](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-composition%23children)[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-composition%23slots)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-composition.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Types of composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-composition%23types-of-composition)\n\n[Blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-composition%23blocks)[Children](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-composition%23children)[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition/docs/guides/vtex-io-documentation-composition%23slots)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_95efe831
|
[
{
"role": "system",
"content": "You are a VTEX 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 productsummarylist in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-productsummarylist/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-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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/vtex-product-summary-productsummarylist/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/vtex-product-summary-productsummarylist/docs/apps/vtex.product-summary/ProductSummaryList%23skusfilterenum)[InstallmentCriteriaEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist/docs/apps/vtex.product-summary/ProductSummaryList%23installmentcriteriaenum)[PreferredSKUEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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_c77c5622
|
[
{
"role": "system",
"content": "You are a VTEX 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 getting started in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-getting-started/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-getting-started/docs/api-reference)\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-getting-started/docs/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-getting-started/docs/storefront-development)\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-getting-started/docs/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-getting-started/docs/troubleshooting)\n\n[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-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/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-getting-started/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-getting-started/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-getting-started/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-getting-started/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started/docs/guides/vtex-io-getting-started)\n\nGetting started\n\nLearn how to build VTEX IO solutions with these learning-oriented tutorials.\n\n[Storefront themeDesign captivating ecommerce themes using Store Framework.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3)[React appsBuild dynamic ecommerce apps with React on VTEX IO.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)[Pixel appsIntegrate your store with third party solutions by developing a VTEX IO Pixel App.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)[ServicesDevelop robust backend services on VTEX IO using VTEX Core Commerce APIs.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\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-getting-started.md)\n\n[Code samples and templates« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started//docs/guides/code-samples)[Storefront appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started//docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\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/vtex-io-getting-started.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_fb4c02dd
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX b2b quotes graphql app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/vtex-io-apps)\n\nB2B Quotes GraphQL\n\nOfficial extension\n\nVersion: 4.0.1\n\nLatest version: 4.0.1\n\n[](#contributors-)\n\nBackend app providing GraphQL queries and mutations for [B2B Quotes](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/b2b-quotes).\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[B2bquotes Graphql APIVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_f30ee7fb
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides images in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/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/images/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/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/images/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/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/images/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/images/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/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/images/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/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/images/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/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/images/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/images/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/catalog-integration)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images)\n\nImages\n\nProduct images are associated with SKUs.\n\nTo learn more, see this article about [Best practices with catalog images](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/best-practices-for-using-images-in-the-catalog--738K2yfq5U86kUI2k4AQIk). It may also be helpful to [compress the images](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-the-automatic-compacting-of-images-works) you use in your store.\n\n## Data Model\n\n| **Field** | **Description** | **Required** | **Type** | **Default** |\n| --------- | ---------------------------------------------------------------------------- | ------------ | -------------------- | ------------- |\n| Id | ID of SkuImage (SkuFileId). This is the ID that is used to delete/update it. | No | Integer | AutoIncrement |\n| ArchiveId | Unique identifier of the Image file. | No | Integer | \\- |\n| SkuId | ID of SKU | Yes | Integer | null |\n| Name | Name of SKU’s file | No\\* | String | null |\n| IsMain | Set the image as the main image for the product. | No | Boolean (true/false) | null |\n| Label | Image label | No | String | false |\n| Url | External image URL | Yes | String | \\- |\n\n## API implementation\n\n### Register SKU image\n\nTo register an image to an SKU, it must be hosted on an external server and with read permission. Then you may use the [Create SKU file API endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-sku-file).\n\n#### Example request\n\nBody:\n\n`1\n\n{ \n\n2\n\n \"IsMain\": true, \n\n3\n\n \"Label\": \"Main\", \n\n4\n\n \"Name\": \"Nike-Red-Janoski-1\", \n\n5\n\n \"Url\": \"https://m.media-amazon.com/images/I/610G2-sJx5L._AC_UX695_.jpg\" \n\n6\n\n} \n\n`\n\nResponse:\n\n`1\n\n{ \n\n2\n\n \"Id\": 520, \n\n3\n\n \"SkuId\": 70, \n\n4\n\n \"ArchiveId\": 155467, \n\n5\n\n \"IsMain\": true, \n\n6\n\n \"Label\": \"Main\" \n\n7\n\n} \n\n`\n\n### Change SKU image\n\nTo change an existing SKU image that already existed, you can use the [Update SKU file endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-put-sku-file).\n\n> In order to update a SKU file the image needs to be uploaded again.\n\n#### Example request\n\nBody:\n\n`1\n\n{ \n\n2\n\n \"IsMain\": true, \n\n3\n\n \"Label\": \"Main2\", \n\n4\n\n \"Name\": \"Nike-Red-Janoski-1\", \n\n5\n\n \"Url\": \"https://m.media-amazon.com/images/I/610G2-sJx5L._AC_UX695_.jpg\" \n\n6\n\n} \n\n`\n\nResponse:\n\n`1\n\n{ \n\n2\n\n \"Id\": 520, \n\n3\n\n \"SkuId\": 70, \n\n4\n\n \"ArchiveId\": 155467, \n\n5\n\n \"IsMain\": true, \n\n6\n\n \"Label\": \"Main2\" \n\n7\n\n} \n\n`\n\n### Remove SKU Image\n\nTo remove an SKU image use the [Delete SKU image by file ID API request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/delete%5Fapi-catalog-pvt-stockkeepingunit-skuid-file-skufileid). You will need the `SkuFileId`.\n\n### Remove all SKU images\n\nTo delete all images of one specific SKU, use the [Delete all SKU file API endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-delete-sku-file).\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/catalog-integration/images.md)\n\n[SKUs« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images//docs/guides/skus)[Alternative API requestsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images//docs/guides/alternative-api-requests)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Data Model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23data-model)\n\n[API implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23api-implementation)\n\n[Register SKU image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23register-sku-image)[Change SKU image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23change-sku-image)[Remove SKU Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23remove-sku-image)[Remove all SKU images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23remove-all-sku-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/Integration-Guides/catalog-integration/images.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Data Model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23data-model)\n\n[API implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23api-implementation)\n\n[Register SKU image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23register-sku-image)[Change SKU image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23change-sku-image)[Remove SKU Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23remove-sku-image)[Remove all SKU images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images/docs/guides/images%23remove-all-sku-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_5eb038fd
|
[
{
"role": "system",
"content": "You are a VTEX 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 cart overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-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/cart-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/cart-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/cart-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/cart-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/cart-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/cart-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/cart-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/cart-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-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/cart-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-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/cart-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview)\n\n[useCart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-use-cart)\n\n[CartProvider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-cart-provider)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/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/cart-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-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/cart-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/cart-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-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/cart-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/cart-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-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/cart-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/cart-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-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/cart-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-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/cart-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview)\n\n[useCart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-use-cart)\n\n[CartProvider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-cart-provider)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/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/cart-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-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/cart-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/cart-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-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/cart-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/cart-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/cart-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/sdk-overview)\n\nCart\n\nThe Cart module offers features to manage the store shopping cart. It handles large orders and complex ecommerce operations, such as marketplace integration, coupons, gift options, and promotions.\n\n## Cart data storage\n\nCart data is saved in the browser's [IndexedDB](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB%5FAPI), ensuring that users' carts remain saved even when they close the browser. The data is structured as follows:\n\n\n\n## Cart modes\n\nThe Cart module provides two modes:\n\n* [**Pure**](#pure-mode) (default): Operates on the client side, storing cart data locally and supporting offline use. It lacks server-side validation and may not handle complex cases like unavailable items. Ideal for basic cart functionality.\n* [**Optimistic**](#optimistic-mode): Handles complex ecommerce operations like unavailable items. Validates the cart state on the server using debounced requests.\n\n## Pure mode\n\nThe Pure mode stores cart data locally in the browser. This allows users to add or remove items and keep their carts even if they close the browser. However, it can't validate items on the server side.\n\nThe Pure cart also works offline but doesn't automatically correct errors. For example, if a customer adds an out-of-stock item, the cart won't prevent it. The item will appear in the cart even though it's unavailable.\n\n### Implementing Pure mode\n\nTo implement the Pure cart mode, follow these steps:\n\n1. Wrap your app with the `CartProvider` component.\n2. Access the cart using the `useCart` hook: \n`1 \nimport { CartProvider, useCart } from '@faststore/sdk' \n2 \n \n3 \n// In the App's root component: \n4 \nconst App = ({ children }) => { \n5 \nreturn <CartProvider>{children}</CartProvider> \n6 \n} \n7 \n \n8 \n// In your component: \n9 \nconst MyComponent = () => { \n10 \nconst { items } = useCart() \n11 \n \n12 \nreturn <div>Number of items on cart: {items.length}</div> \n13 \n} \n`\n\n## Optimistic mode\n\nOptimistic mode validates the cart state on the server and handles edge cases like unavailable items. For example, Optimistic mode checks with the store system if a customer tries to add an out-of-stock item. If the product is unavailable, it's removed from the cart, and the customer is notified.\n\nThis feature can be implemented in the `optimistic` mode using the `validateCart` callback function, which allows developers to make requests and cause side effects to the cart. If the function returns `null`, the cart behavior doesn't change. However, if you opt to change the cart state to handle a specific side effect, it must return the new cart state within the callback function.\n\n### Implementing Optimistic mode\n\nTo implement the Optimistic cart mode, follow these steps:\n\n1. Use the `CartProvider` component with the `optimistic` mode.\n2. Implement the `validateCart` function to handle server-side validation: \n`1 \nimport { CartProvider, useCart, Cart } from '@faststore/sdk' \n2 \n \n3 \n// In the App's root component: \n4 \nconst validateCart = async (cart: Cart) => { \n5 \nconst response = await fetch(...) \n6 \n \n7 \nif (response) { \n8 \n return response \n9 \n} \n10 \n \n11 \nreturn null \n12 \n} \n13 \n \n14 \nconst App = ({children}) => { \n15 \nreturn <CartProvider mode=\"optimistic\" onValidateCart={validateCart}>{children}</CartProvider> \n16 \n} \n17 \n \n18 \n// In your component: \n19 \nconst MyComponent = () => { \n20 \nconst { items, isValidating } = useCart() \n21 \n \n22 \nif (isValidating) { \n23 \n return <div>Cart is validating</div> \n24 \n} \n25 \n \n26 \nreturn <div>Number items in cart: {items.length}</div> \n27 \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/sdk/cart/overview.mdx)\n\n[Use case: Implementing custom newsletter analytics events« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)[useCartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-use-cart)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Cart data storage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23cart-data-storage)\n\n[Cart modes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23cart-modes)\n\n[Pure mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23pure-mode)\n\n[Implementing Pure mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23implementing-pure-mode)\n\n[Optimistic mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23optimistic-mode)\n\n[Implementing Optimistic mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23implementing-optimistic-mode)\n\nWas this helpful?\n\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/cart/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Cart data storage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23cart-data-storage)\n\n[Cart modes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23cart-modes)\n\n[Pure mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23pure-mode)\n\n[Implementing Pure mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23implementing-pure-mode)\n\n[Optimistic mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23optimistic-mode)\n\n[Implementing Optimistic mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview/docs/guides/faststore/cart-overview%23implementing-optimistic-mode)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_7fb7bc0e
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides tax services 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/tax-services-specification/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-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/tax-services-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/tax-services-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/tax-services-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/tax-services-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/tax-services-specification/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-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/tax-services-specification/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-recipe)\n\n[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-protocol-graphql-api)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-reference-implementation)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-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/tax-services-specification/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-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/tax-services-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/tax-services-specification/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-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/tax-services-specification/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-recipe)\n\n[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-protocol-graphql-api)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-reference-implementation)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-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/tax-services-specification/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-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/tax-services-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/tax-services-specification/docs/guides)\n\nIntegration Guides\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-service-integration-guide)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification)\n\nSpecification\n\nIn synchronous integration, VTEX’s [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) triggers and sends a request to the external tax service API whenever there are changes to a shopper’s cart, such as adding or removing items.\n\nTo learn more about how to implement a client to connect your tax calculation provider to VTEX’s APIs, check the [Tax Service recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-recipe) and [example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation).\n\n> The timeout for the request is five seconds. There is no retry in case of timeout. If the external service that responds to the request times out constantly, the store will not be able to finish the order. If this integration is active, it applies to all stores in that account.\n\n## Tax integration via Checkout API\n\nYou must activate the tax integration by configuring the `orderForm`, an object that stores contextual information about the order. This data is essential to the checkout process of the order.\n\nCheck the flow of `orderForm` configuration below:\n\n\n\n### Get `orderForm`\n\nTo activate the tax integration, first it is necessary to get the current `orderForm` settings using the [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm?endpoint=get-/api/checkout/pvt/configuration/orderForm) endpoint.\n\nIn the endpoint response, the `taxConfiguration` object has the tax information that must be updated, as in the example below:\n\n`1\n\n{ \n\n2\n\n \"taxConfiguration\": { \n\n3\n\n \"url\": \"https://{accountName}.myvtex.com/tax-service/order-tax\", \n\n4\n\n \"authorizationHeader\": \"99b9935b048dfd86893d0bf9gas628849\", \n\n5\n\n \"appId\": \"tradeincart\", \n\n6\n\n \"isMarketplaceResponsibleForTaxes\": false, \n\n7\n\n ... \n\n8\n\n} \n\n`\n\n### Update `orderForm`\n\nThen, Checkout settings must be updated using the [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) endpoint.\n\nIn the `taxConfiguration` object, it is important to update the following fields.\n\n| Property name | Description | Example |\n| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |\n| url | String of external API endpoint of the tax provider that the Checkout will query to receive the calculated taxes. | \"https://sandbox-rest.avatax.com/api/v2/transactions/create\" |\n| authorizationHeader | String that the Checkout will use in the Authorization header of calls to the external tax calculation API. This field can be used to define the access credentials for this API. | \"99b9935b048dfd86893d0bf9gas628849\" |\n| isMarketplaceResponsibleForTaxes | Boolean that indicates whether the marketplace is responsible for calculating taxes for the products (true) or if the responsibility lies with the seller (false). | true |\n\n> The `isMarketplaceResponsibleForTaxes` feature is not compatible with stores that have [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) implemented.\n\nHere is an example of the `taxConfiguration` object with the expected information:\n\n`1\n\n{ \n\n2\n\n \"taxConfiguration\": { \n\n3\n\n \"url\": \"{Tax provider URL}\", \n\n4\n\n \"authorizationHeader\": \"{Tax provider authorization header}\", \n\n5\n\n \"appId\": \"tradeincart\", \n\n6\n\n \"isMarketplaceResponsibleForTaxes\": true, \n\n7\n\n ... \n\n8\n\n }, \n\n9\n\n ... \n\n10\n\n} \n\n`\n\n> You must send the entire `orderForm` in the request body in the [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) endpoint.\n\nAfter successfully submitting the request, the Tax API integration becomes active in synchronous mode.\n\n> When a purchase is made in a store, the location from which the order is shipped matters for tax calculation purposes. Because of this, when items from [White Label Sellers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/white-label-seller--5orlGHyDHGAYciQ64oEgKa) are part of an order, tax configuration for the marketplace (`seller 1`) is not taken into account for those items. Each seller must have its own tax service configuration in order for this type of integration function properly.\n\n## Tax calculation request\n\nThe external tax calculation service must provide an endpoint, as the `https://sandbox-rest.avatax.com/api/v2/transactions/create` example, that will receive a `POST` request. In this request, Checkout provides a body in a specific format. This means that either the endpoint must be prepared to receive this body format, or the integration must contain a parser to adapt it to the correct format.\n\nHere is an example of that body sent by Checkout API:\n\n`1\n\n{ \n\n2\n\n \"orderFormId\": \"e5098ad8c4jk490bb2f6f03400ac1413\", \n\n3\n\n \"salesChannel\": \"1\", \n\n4\n\n \"items\": [ \n\n5\n\n { \n\n6\n\n \"id\": \"0\", \n\n7\n\n \"sku\": \"26\", \n\n8\n\n \"productId\": \"12\", \n\n9\n\n \"ean\": \"12345678909123\", \n\n10\n\n \"refId\": \"3432\", \n\n11\n\n \"categoryId\": \"3\", \n\n12\n\n \"unitMultiplier\": 1, \n\n13\n\n \"measurementUnit\": \"un\", \n\n14\n\n \"targetPrice\": 8.2, \n\n15\n\n \"itemPrice\": 8.2, \n\n16\n\n \"quantity\": 1, \n\n17\n\n \"discountPrice\": 0, \n\n18\n\n \"dockId\": \"1125a08\", \n\n19\n\n \"freightPrice\": 0, \n\n20\n\n \"brandId\": \"2000002\", \n\n21\n\n \"taxCode\": \"PC040210\", \n\n22\n\n \"sellerId\": \"1\" \n\n23\n\n } \n\n24\n\n ], \n\n25\n\n \"totals\": [ \n\n26\n\n { \n\n27\n\n \"id\": \"Items\", \n\n28\n\n \"name\": \"Items Total\", \n\n29\n\n \"value\": 820 \n\n30\n\n }, \n\n31\n\n { \n\n32\n\n \"id\": \"Discounts\", \n\n33\n\n \"name\": \"Discounts Total\", \n\n34\n\n \"value\": 0 \n\n35\n\n }, \n\n36\n\n { \n\n37\n\n \"id\": \"Shipping\", \n\n38\n\n \"name\": \"Shipping Total\", \n\n39\n\n \"value\": 0 \n\n40\n\n }, \n\n41\n\n { \n\n42\n\n \"id\": \"Tax\", \n\n43\n\n \"name\": \"Tax Total\", \n\n44\n\n \"value\": 0 \n\n45\n\n } \n\n46\n\n ], \n\n47\n\n \"clientEmail\": \"client@email.com\", \n\n48\n\n \"shippingDestination\": { \n\n49\n\n \"country\": \"BRA\", \n\n50\n\n \"state\": \"RJ\", \n\n51\n\n \"city\": \"Rio de Janeiro\", \n\n52\n\n \"neighborhood\": \"Botafogo\", \n\n53\n\n \"postalCode\": \"22250-905\", \n\n54\n\n \"street\": \"Praia Botafogo\" \n\n55\n\n }, \n\n56\n\n \"clientData\": { \n\n57\n\n \"email\": \"client@email.com\", \n\n58\n\n \"document\": \"12345678909\", \n\n59\n\n \"documentType\": \"cpf\", \n\n60\n\n \"clientProfileData\": \"12345678000100\", \n\n61\n\n \"stateInscription\": \"12345678\" \n\n62\n\n }, \n\n63\n\n \"paymentData\": { \n\n64\n\n \"payments\": [ \n\n65\n\n { \n\n66\n\n \"paymentSystem\": \"2\", \n\n67\n\n \"bin\": null, \n\n68\n\n \"referenceValue\": 820, \n\n69\n\n \"value\": 820, \n\n70\n\n \"installments\": null \n\n71\n\n } \n\n72\n\n ] \n\n73\n\n }, \n\n74\n\n \"taxApp\": { \n\n75\n\n \"fields\": { \n\n76\n\n \"isTradeIn\": \"Yes\", \n\n77\n\n \"productuid\": \"15216842581\", \n\n78\n\n \"quoteuid\": \"29882961591\", \n\n79\n\n \"condition\": \"working\", \n\n80\n\n \"tradeInPrice\": \"220.00\", \n\n81\n\n \"title\": \"ROG Phone II 512GB\", \n\n82\n\n \"productIdApplied\": \"404\", \n\n83\n\n \"uid\": \"29882961591\", \n\n84\n\n \"taxBase\": \"1399.99\" \n\n85\n\n }, \n\n86\n\n \"id\": \"tradeincart\", \n\n87\n\n \"major\": 1 \n\n88\n\n } \n\n89\n\n} \n\n`\n\nThis body has the main fields:\n\n| Field | Type | Description |\n| ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| orderFormId | string | orderform ID. |\n| salesChannel | string | Trade policy ID. |\n| items | array | List of objects which are the order products, where dockId is a field that refers to its identification on the Logistics system that contains information of its address. |\n| totals | array | Total amount of the orderForm, divided into taxes, shipping, discounts, and the items prices. |\n| clientEmail | string | Client's email. address. |\n| shippingDestination | object | Shipping information. Mandatory. field. |\n| clientData | object | Information regarding the client that placed the order. |\n| paymentData | object | Contains an array of payments, where there is information regarding the order payment. |\n| taxApp | object | Contains an object with custom fields specific to the tax application. |\n\n### Tax provider response to the request\n\nIn response to the request sent by Checkout, it is expected that the external tax provider API returns an array of products, each with its own array of taxes. See the example below:\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"id\": \"0\", \n\n4\n\n \"taxes\": [ \n\n5\n\n { \n\n6\n\n \"name\": \"TAX 1\", \n\n7\n\n \"description\": \"This tax represents a standard sales tax applied to the item.\", \n\n8\n\n \"value\": 3.48 \n\n9\n\n }, \n\n10\n\n { \n\n11\n\n \"name\": \"TAX 2\", \n\n12\n\n \"description\": \"This tax is a special surcharge imposed by the government for environmental conservation purposes.\", \n\n13\n\n \"value\": 22 \n\n14\n\n } \n\n15\n\n ] \n\n16\n\n } \n\n17\n\n] \n\n`\n\nThe following JSON represents a list of taxes associated with a particular item, with each tax defined by its name, description, and value:\n\n| Field | Type | Description |\n| ----------- | ------ | ----------------------------------------------------------------------------------------------- |\n| id | string | Request item index, which means the SKU's position on the items array sent by the request body. |\n| taxes | array | List of all the taxes types for an SKU. |\n| name | string | Tax name that will appear on the checkout. |\n| description | string | Informative field, which does not appear on the storefront. |\n| value | number | Absolute numeric value that will be added to the original price. |\n\nIn the example above, the only item in the items array has a cost of `10`, and, including the calculated taxes returned by the tax calculation tool, the total value would be `10 + 3.48 + 22 = 35.48`.\n\n> If no taxes apply to the items in the order, the expected response is an empty array (`[]`).\n\nFor the Checkout API to interpret the request body, the `Content-type` must be set to `application/vnd.vtex.checkout.minicart.v1+json`.\n\n#### Jurisdiction fields\n\nIf you use [Avalara](https://read.calvincode.net/reader?url=https://www.avalara.com/us/en/index.html) as your tax calculation provider, response bodies can also include the following fields, which refer to the different jurisdictions that may apply according to location.\n\n| Field | Type | Description |\n| --------- | ------ | --------------------------------------------------------- |\n| jurisType | string | Type of jurisdiction that applies to calculation. |\n| jurisCode | string | Unique code that identifies the appropriate jurisdiction. |\n| jurisName | string | Name of the jurisdiction that applies to the calculation. |\n\nThese fields are also read by Checkout and added to the `priceTag`.\n\nBelow is an example for values that may be contained in these fields, and you can [download all of the jurisdictions and respective codes used by Avalara](https://read.calvincode.net/reader?url=https://help.avalara.com/Avalara%5FAvaTax%5FUpdate/Download%5Fjurisdiction%5Fcodes).\n\n`1\n\n{ \n\n2\n\n \"Id\": \"0\", \n\n3\n\n \"taxes\": [ \n\n4\n\n { \n\n5\n\n \"name\": \"NY STATE TAX: NEW YORK\", \n\n6\n\n \"description\": \"Srixon Q-Star Tour Golf Balls 5013392- Dozen Yellow\", \n\n7\n\n \"rate\": 0.04, \n\n8\n\n \"value\": 1.4, \n\n9\n\n \"jurisCode\": \"36\", \n\n10\n\n \"jurisType\": \"State\", \n\n11\n\n \"jurisName\": \"NEW YORK\" \n\n12\n\n }, \n\n13\n\n { \n\n14\n\n \"name\": \"NY COUNTY TAX: ERIE\", \n\n15\n\n \"description\": \"Srixon Q-Star Tour Golf Balls 5013392- Dozen Yellow\", \n\n16\n\n \"rate\": 0.0475, \n\n17\n\n \"value\": 1.66, \n\n18\n\n \"jurisCode\": \"029\", \n\n19\n\n \"jurisType\": \"County\", \n\n20\n\n \"jurisName\": \"ERIE\" \n\n21\n\n }, \n\n22\n\n { \n\n23\n\n \"name\": \"NY STATE TAX: NEW YORK (SHIPPING)\", \n\n24\n\n \"description\": \"freight\", \n\n25\n\n \"rate\": 0.04, \n\n26\n\n \"value\": 0.17, \n\n27\n\n \"jurisCode\": \"36\", \n\n28\n\n \"jurisType\": \"State\", \n\n29\n\n \"jurisName\": \"NEW YORK\" \n\n30\n\n }, \n\n31\n\n { \n\n32\n\n \"name\": \"NY COUNTY TAX: ERIE (SHIPPING)\", \n\n33\n\n \"description\": \"freight\", \n\n34\n\n \"rate\": 0.0475, \n\n35\n\n \"value\": 0.2, \n\n36\n\n \"jurisCode\": \"029\", \n\n37\n\n \"jurisType\": \"County\", \n\n38\n\n \"jurisName\": \"ERIE\" \n\n39\n\n } \n\n40\n\n ] \n\n41\n\n} \n\n`\n\nBy following these guidelines and leveraging the provided examples, you can incorporate tax integration into your VTEX platform.\n\nContributors\n\n5\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/tax-service-integration-guide/tax-services-specification.md)\n\n[Overview« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification//docs/guides/tax-services-overview)[RecipeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification//docs/guides/tax-services-recipe)\n\nContributors\n\n5\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Tax integration via Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification%23tax-integration-via-checkout-api)\n\n[Get orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification%23get-orderform)[Update orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification%23update-orderform)\n\n[Tax calculation request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification%23tax-calculation-request)\n\n[Tax provider response to the request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification%23tax-provider-response-to-the-request)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/tax-service-integration-guide/tax-services-specification.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Tax integration via Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification%23tax-integration-via-checkout-api)\n\n[Get orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification%23get-orderform)[Update orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification%23update-orderform)\n\n[Tax calculation request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification%23tax-calculation-request)\n\n[Tax provider response to the request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification/docs/guides/tax-services-specification%23tax-provider-response-to-the-request)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_5c81ae33
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides implementing cache in graphql apis for io apps in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/app-development)\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/graphql-in-vtex-io)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\nImplementing cache in GraphQL APIs for IO apps\n\nLearn how to implement and configure cache in your GraphQL APIs for faster responses.\n\nIn the context of APIs, caching is a technique that allows applications to return the same data for repeated requests to the same endpoint, avoiding unnecessary computational costs and improving response times.\n\nWhen [implementing GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps) in VTEX IO, you can enable caching and control its behavior using the `@cacheControl` directive. Queries that use this directive can define the scope of users and how long the content remains cached.\n\nReturning cached data is faster than reprocessing data for every request, so caching is generally advised when possible.\n\n## When to use caching\n\nCaching is recommended in the following scenarios:\n\n* High volume of requests for the same queries or data.\n* Response data doesn't mutate frequently.\n* It's acceptable to have stale data in a short time window.\n\nOn the other hand, caching isn't recommended when:\n\n* Response data mutates frequently.\n* Stale data isn't acceptable. Responses must always be up-to-date.\n\n## Before you begin\n\nThis guide assumes you have already implemented a GraphQL API in a VTEX IO service app, as described in the [Developing a GraphQL API in Service Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps) guide. Before enabling caching, review your API's data characteristics and the user experience in case of stale data.\n\n## Using the `@cacheControl` directive\n\nThe `@cacheControl` directive defines the scope of access and duration of cached responses for specific queries and fields in your GraphQL schema.\n\n### `@cacheControl` arguments\n\nThe `@cacheControl` directive uses the following arguments:\n\n* `scope`: Defines which users can access the cached endpoint or field. Choose the scope based on the level of privacy you want for the cached data. The possible values are: \n * `PUBLIC`: Cached data can be accessed by any authenticated user. \n * `SEGMENT`: Cached data can be accessed by users of the same segment as the one who made the first request. Users are divided into segments based on different criteria such as region, audience, or sales channel. VTEX handles segmentation automatically using data from the [vtex\\_segment cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23vtexsegment-cookie). \n * `PRIVATE`: Cached data can only be accessed by the user who made the first request.\n* `maxAge`: The time in seconds for which the endpoint response or field remains cached. If a subsequent request is made within the `maxAge` period after the last request, the app returns the cached value instead of reprocessing it. If this value is 0, the data won't be cached.\n\n> The `@cacheControl` directive affects only cached results. This directive doesn't provide any access control for requests with uncached data. For details about access control with GraphQL using VTEX IO, see [GraphQL Authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps).\n\n### Example\n\nThe following example caches the `userProfile` query for 5 minutes (300 seconds) and restricts access to the user who initiated the request:\n\n`1\n\ntype Query { \n\n2\n\n userProfile: UserProfile \n\n3\n\n @cacheControl(scope: PRIVATE, maxAge: 300) \n\n4\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/GraphQL/implementing-cache-in-graphql-apis-for-io-apps.md)\n\n[Integrating an app with a GraphQL API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps//docs/guides/integrating-an-app-with-a-graphql-api)[Admin GraphQL IDENext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps//docs/guides/graphql-ide)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[When to use caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps%23when-to-use-caching)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps%23before-you-begin)\n\n[Using the @cacheControl directive](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps%23using-the-cachecontrol-directive)\n\n[@cacheControl arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps%23cachecontrol-arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps%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/GraphQL/implementing-cache-in-graphql-apis-for-io-apps.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[When to use caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps%23when-to-use-caching)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps%23before-you-begin)\n\n[Using the @cacheControl directive](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps%23using-the-cachecontrol-directive)\n\n[@cacheControl arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps%23cachecontrol-arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-cache-in-graphql-apis-for-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps%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_79ab8219
|
[
{
"role": "system",
"content": "You are a VTEX 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 go live in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-go-live/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-go-live/docs/api-reference)\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-go-live/docs/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-go-live/docs/storefront-development)\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-go-live/docs/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-go-live/docs/troubleshooting)\n\n[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-go-live/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-go-live/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-go-live/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/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-go-live/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-go-live/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/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-go-live/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-go-live/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-go-live/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-go-live/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-go-live/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/store-framework)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live)\n\nGoing live with a new store\n\nThis article will guide you through the steps you must take to make your ecommerce available to shoppers if it was developed with Store Framework. To get a complete overview of the go-live process for any VTEX store, see this [Go-live guide](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/1iP90RcJvlrfQhnlxM54wo).\n\n> The steps below also apply if you are migrating your store from another ecommerce platform. You can also learn about how to [migrate your storefront from the Legacy CMS Portal to CMS Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io).\n\n## Before you begin\n\nThere are a few things you must check to make sure you are ready to go live.\n\n* [Account edition](#account-edition)\n* [Storefront development](#storefront-development)\n\n### Account edition\n\nYou must set your account edition to develop a storefront in Store Framework. If your storefront is ready, it is very likely you already have the correct [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) installed. You can check the Edition app installed in any given workspace by running the following command in your terminal: `vtex edition get`. Please refer to [Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) for further information.\n\nIf you do not have the appropriate Edition app installed, open a [support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) requesting the installation of the `vtex.edition-store@5.x` [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) in your `master` [workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace).\n\n> Once the Store Edition is installed in the master [workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) of your account, all new workspaces you create will use this same Edition app. Other workspaces that existed previously will remain with the [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) they already had.\n\n### Storefront development\n\nYou must develop your storefront before going live. Check these guides to learn how to use VTEX IO to create amazing storefronts with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework):\n\n* [CMS IO basic concepts](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/4yB9wSl79cArd68aRBnBZ2)\n* [Storefront implementation overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation)\n* [Storefront apps overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps)\n* [Building a Store Framework theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3)\n\n## Instructions\n\nTo go live with your VTEX store, built with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework), follow these steps:\n\n1. [Register host](#step-1---registering-the-store's-domain)\n2. [Request internal DNS pointing](#step-2---requesting-internal-dns-pointing)\n3. [Set up regular DNS pointing](#step-3---setting-up-dns-pointing)\n\n> Consider planning the entire go-live process at least two weeks in advance, as some of the steps below are time-sensitive.\n\n### Step 1 - Registering the store's domain\n\nTo launch your store, you must own a [domain name](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Domain%5Fname). If you have not already, you can buy one from a domain provider.\n\n> VTEX uses **Cloudfront** as CDN provider in the stores. Your store's domain must not be registered with Cloudfront by the time you perform the pointing. Otherwise, there will be a failure in the CDN provisioning for your store and, consequently, at go-live. So, if you have the store domain registered on the **Cloudfront** platform, delete it before pointing the DNS to VTEX.\n\n[Configure your domain as your store's host](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-domains-in-license-manager--tutorials%5F2450) as presented in this guide to make sure that shoppers will be directed to your new VTEX store.\n\n### Step 2 - Requesting internal DNS pointing\n\nVTEX provides different [storefront solutions](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/cms--2YcpgIljVaLVQYMzxQbc3z). This step ensures that the domain you [registered as your VTEX host](#step-1---registering-the-store's-domain) points users to the storefront built with Store Framework.\n\nRequest VTEX internal DNS pointing change for Store Framework via [support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support). When opening your ticket keep in mind that you must:\n\n* Make it clear that you wish to go live in the title of the ticket.\n* Indicate a time from 9 to 17 BRT (UTC-3) for the internal pointing change to happen.\n* Indicate whether or not your store has any [trade policy conditional rules](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/criar-uma-politica-comercial--563tbcL0TYKEKeOY4IAgAE).\n\nThis process takes about three business days. Once you receive a successful reply from the support ticket, you have five days to [set up regular DNS pointing](#step-3---setting-up-dns-pointing).\n\n### Step 3 - Setting up DNS pointing\n\nWithin five days of the confirmation of [internal DNS pointing](#step-2---requesting-internal-dns-pointing) you must set up regular DNS pointing. Otherwise, your internal pointing will be automatically excluded and you will need to request it again, as described above.\n\nUnlike the previous step, regular DNS pointing must be set up by you and guarantees that your domain points to VTEX so that the platform can deliver your storefront to shoppers.\n\nTo do this, follow the instructions in [Setting up DNS pointing to VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/12bQlMbJ68Ot0LIaO6Btkj).\n\n> DNS pointing propagation takes 24-48 hours to occur completely, which means that the configured address may not be accessible to all people right after configuration.\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/vtex-io-documentation-going-live/vtex-io-documentation-go-live.md)\n\n[Improving store accessibility with semantic HTML migration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live//docs/guides/vtex-io-documentation-semantic-html-migration)[Updating live storesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live//docs/guides/store-framework-updating-live-stores)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\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-go-live/docs/guides/vtex-io-documentation-go-live%23before-you-begin)\n\n[Account edition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23account-edition)[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23storefront-development)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23instructions)\n\n[Step 1 - Registering the store's domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23step-1-registering-the-stores-domain)[Step 2 - Requesting internal DNS pointing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23step-2-requesting-internal-dns-pointing)[Step 3 - Setting up DNS pointing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23step-3-setting-up-dns-pointing)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-documentation-going-live/vtex-io-documentation-go-live.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-go-live/docs/guides/vtex-io-documentation-go-live%23before-you-begin)\n\n[Account edition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23account-edition)[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23storefront-development)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23instructions)\n\n[Step 1 - Registering the store's domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23step-1-registering-the-stores-domain)[Step 2 - Requesting internal DNS pointing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23step-2-requesting-internal-dns-pointing)[Step 3 - Setting up DNS pointing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live/docs/guides/vtex-io-documentation-go-live%23step-3-setting-up-dns-pointing)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_c63af81e
|
[
{
"role": "system",
"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 profile system 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/profile-system/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/docs/api-reference/profile-system/)\n\nProfiles\n\nAddresses\n\nProspects\n\nPurchase information\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/profile-system/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/profile-system/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/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/profile-system/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/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/profile-system/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/profile-system/docs/api-reference/profile-system/)\n\nProfiles\n\nAddresses\n\nProspects\n\nPurchase information\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/profile-system/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoRefresh token« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/api-reference/vtex-id-api%23post-/api/vtexid/refreshtoken/webstore)[PoCreate client profileNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system/docs/api-reference/profile-system%23post-/api/storage/profile-system/profiles)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_28c253d8
|
[
{
"role": "system",
"content": "You are a VTEX 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 validating utm tracking in faststore in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/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-validating-utm-tracking-in-faststore/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-validating-utm-tracking-in-faststore/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-validating-utm-tracking-in-faststore/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-validating-utm-tracking-in-faststore/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/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-validating-utm-tracking-in-faststore/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-validating-utm-tracking-in-faststore/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-validating-utm-tracking-in-faststore/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-validating-utm-tracking-in-faststore/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-overview)\n\nValidating UTM tracking in FastStore\n\nValidating UTM (Urchin Tracking Module) tracking ensures your marketing campaigns are accurately measured and can deliver personalized experiences to boost conversions. When a customer clicks a campaign link — such as from an email, social media post, or paid ad — UTM parameters like `utm_source`, `utm_medium`, and `utm_campaign`, are attached to the URL. These parameters help identify where the traffic is coming from, which campaigns are driving engagement, and how users navigate through your store.\n\nIf UTM data is lost during navigation, search, or checkout, your analytics and promotional strategies may be affected. For example, you might be unable to determine whether a sale came from a Google Ads campaign or an organic search. Also, if UTMs aren't properly passed to checkout, UTM-based promotions (such as 10% off for users from a winter sale campaign) won't apply.\n\nBy validating UTM tracking, you confirm that:\n\n* Campaign data is captured when users access your site.\n* UTM parameters persist as users browse, search, and add items to their cart.\n* Checkout retains UTM data, enabling accurate order attribution in reports.\n\nIn this guide, you'll learn how to verify that UTM parameters are correctly captured and persist from store entry to checkout.\n\n## Before you begin\n\nTo capture and retain UTM data from a visitor and attach it to their order, make sure your FastStore project is on version `3.27.0` or later. To update your store to the latest version, follow these steps:\n\n1. Open your FastStore project in a code editor of your preference.\n2. Open the terminal and run the following command to update FastStore packages: \n`1 \nyarn upgrade -L --scope @faststore \n`\n\n## Instructions\n\n### Step 1: Test UTM capture in store session\n\nTo verify if UTMs are stored when a user visits your store, simulate a campaign visit in your development environment:\n\n1. Open the terminal and run `yarn dev` to start the server locally.\n2. Open the localhost available and add a UTM parameter on its slug, for example: \n`1 \nhttp://localhost:3000/?utm_source=google \n` \n> Adding `?utm_source=google` simulates a user arriving from a Google Ads campaign.\n3. To confirm if the `utm_source=google` was captured when the user acessed the store, open your Developer Tools in your browser and click the **Application** tab.\n4. Go to the **Storage** section and navigate to **IndexedDB > keyval-store**.\n5. Expand the **keyval-store** option and click **keyval**.\n6. In the **Value** column, expand `addressType`.\n7. Find the `marketingData` field and expand it. There, you'll see the `utmSource: \"google\"` parameter, which means it was captured during the user's session. \n\n\n### Step 2: Verify checkout attribution\n\nWhen a user arrives at your store through a link containing, for example, `?utm_source=google` and adds a product to the cart, the system does the following:\n\nUserBrowserFastStoreVTEXDatabaseClicks ad linkRequests URL with UTMsStores UTMs in sessionStorageSubsequent requests include orderFormIdPersists UTMs with orderUserBrowserFastStoreVTEXDatabase\n\n1. Creates an `orderFormId`, a cart identifier for the user's cart.\n2. Attaches the UTM data to the cart.\n3. Maintains UTM data throughout the purchase process for: \n * Accurate sales attribution, so you know from which traffic source this order came, such as Google Ads or organic traffic. \n * Campaign-specific promotions, such as 30% off for `utm_campaign=winter_sale`.\n\nAnother benefit of keeping UTM data throughout the purchase process is the ability to apply campaign-specific discounts. For example, a customer receives an email newsletter from your store with a promotion of 30% off the winter collection with the link `https://store.com?utm_source=newsletter&utm_medium=email&utm_campaign=winter_sale`. When the user clicks the link, adds a $100 product to the cart, and proceed to checkout, the system:\n\n* Tracks the sale under `winter_sale`.\n* Applies a 30% discount to the total price.\n\nNow, let's make sure the `utm_source=google` is attached to the order on the client side:\n\n1. Go to the store homepage by accessing the localhost (`http://localhost:3000/?utm_source=google`).\n2. Click a product to go to its Product Detail Page (PDP).\n3. In the PDP, add the product by clicking `Add to Cart`.\n4. Open Developer Tools in your browser and click the **Application** tab to find the `orderFormId` (the cart identifier). \n> The `orderFormId` is a unique identifier assigned to a user's shopping cart (or order form) in the store. This identifier tracks items added to the cart, user session details (such as UTM parameters, shipping preferences), pricing, promotions, and checkout progress.\n5. Go to **Cookies** and find `checkout.vtex.com`.\n6. Copy the cookie value after `__ofid=` and save it. For example, if you see the following, `__ofid=a1b2c2x4y5z`, copy only `a1b2c2x4y5z`.\n\n### Step 3: Call the Checkout API to confirm the UTM is in the cart\n\nSo far, we've confirmed that the `utm_source=google` parameter was captured client-side, so the browser received the UTM data. Now, let's check whether the server also received and retained this data through to checkout. To do this, use the [Get Cart by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm/-orderFormId-) endpoint.\n\n1. Use this endpoint by adding the cookie value you saved in the [previous step](#step-2-verify-checkout-attribution). The base URL will look like this: \n`1 \nhttps://{accountName}.{environment}.com.br/api/checkout/pub/orderForm/a1b2c2x4y5z \n`\n2. Run this endpoint.\n3. In the response body, look for the `marketingData` object field. Inside it, you should find `utmSource: \"google\"`. \n> The `marketingData` object in the Checkout API contains promotion data such as coupon tracking information and internal or external UTMs.\n\nWith these local tests, you can confirm that UTM data is handled both client-side and server-side, persisting from the user's entry into your store through to checkout.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/seo/validating-utm-tracking-in-faststore.mdx)\n\n[Optimizing SEO by managing lazy loading on PLPs and PDPs« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp)[Going liveNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/go-live-overview)\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/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-validating-utm-tracking-in-faststore%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-validating-utm-tracking-in-faststore%23instructions)\n\n[Step 1: Test UTM capture in store session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-validating-utm-tracking-in-faststore%23step-1-test-utm-capture-in-store-session)[Step 2: Verify checkout attribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-validating-utm-tracking-in-faststore%23step-2-verify-checkout-attribution)[Step 3: Call the Checkout API to confirm the UTM is in the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-validating-utm-tracking-in-faststore%23step-3-call-the-checkout-api-to-confirm-the-utm-is-in-the-cart)\n\nWas this helpful?\n\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/validating-utm-tracking-in-faststore.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-validating-utm-tracking-in-faststore%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-validating-utm-tracking-in-faststore%23instructions)\n\n[Step 1: Test UTM capture in store session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-validating-utm-tracking-in-faststore%23step-1-test-utm-capture-in-store-session)[Step 2: Verify checkout attribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-validating-utm-tracking-in-faststore%23step-2-verify-checkout-attribution)[Step 3: Call the Checkout API to confirm the UTM is in the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-validating-utm-tracking-in-faststore/docs/guides/faststore/seo-validating-utm-tracking-in-faststore%23step-3-call-the-checkout-api-to-confirm-the-utm-is-in-the-cart)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_c6f123bc
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides gift card 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/gift-card-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/gift-card-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/gift-card-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/gift-card-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/gift-card-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/gift-card-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/gift-card-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-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/gift-card-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-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/gift-card-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/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/gift-card-integration-guide/docs/guides/managing-vtex-gift-cards)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-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/gift-card-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/gift-card-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-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/gift-card-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/gift-card-integration-guide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-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/gift-card-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-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/gift-card-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/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/gift-card-integration-guide/docs/guides/managing-vtex-gift-cards)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-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/gift-card-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/gift-card-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-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/gift-card-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/gift-card-integration-guide/docs/guides)\n\nIntegration Guides\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/gift-card-integration-guide)\n\nGift Card\n\nIn VTEX, gift cards are a payment option that allows brands to manage loyalty programs, create refund vouchers and accept physical gift cards in their online storefronts.\n\nThere are two ways a VTEX store can offer gift cards to their customers:\n\n* Using our native gift card provider\n* Integrating an external gift card provider\n\nTo use our native gift card solution, simply set it up as a payment method and your customers will be able to use their gift cards on your store's checkout. These gift cards are created and managed in your store's admin panel.\n\nTo integrate with an external gift card provider, however, you must develop a middleware according to our [Gift Card Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol%23overview). This tutorial will present the main concepts and guide you through the steps required to complete this integration.\n\n> Stores may activate multiple gift card providers. For example, you may use our native gift card provider and two external providers.\n\n## Structure of this guide\n\n| Article | Description |\n| ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |\n| [Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture) | How to identify the payment methods' ID and set up the interest rate type using the Payments Gateway API. |\n| [Managing VTEX gift cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards) | How to manage VTEX native gift cards from the VTEX gift card provider through the GiftCard API. |\n\n> This guide is currently being written and published as content become available.\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/gift-card-integration-guide.md)\n\n[Catalog management for VTEX Marketplace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide//docs/guides/external-seller-integration-vtex-marketplace-operation)[Gift Card system architectureNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide//docs/guides/gift-card-integration-guide-system-architecture)\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Structure of this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/gift-card-integration-guide%23structure-of-this-guide)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/gift-card-integration-guide.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Structure of this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide/docs/guides/gift-card-integration-guide%23structure-of-this-guide)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_f96e991d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides calling commerce apis conclusion in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-conclusion)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-conclusion)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/app-development-guides)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion/docs/guides/calling-commerce-apis-conclusion)\n\nCalling Commerce APIs - Conclusion\n\nWith what was accomplished during the course, you should be able to use VTEX Commerce APIs in your apps through the use of Clients and have access to the functionalities of VTEX Core Services. The Clients are used in middlewares and retrieved from the `clients` property of `ctx` (Context). The Clients available in the `@vtex/clients` library are ready-made and have functions that make the API calls, eliminating the need to explicit the endpoint path in the middleware.\n\nYou can do more with Clients than accessing VTEX Commerce APIs. If you wish to access external providers, you can create your own custom Clients.\n\nFurthermore, we saw that authentication is done in a specific way on VTEX IO. You have to use the proper token to identify who is the caller of the endpoint (the app, an Admin user or a Store user) and add the necessary policies in your manifest for the resources that the app will access.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Calling Commerce APIs/calling-commerce-apis-conclusion.mdx)\n\n[3\\. Using VTEX IO clients« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion//docs/guides/calling-commerce-apis-3-using-vtex-io-clients)[ClientsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-conclusion//docs/guides/vtex-io-documentation-clients)\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/Calling Commerce APIs/calling-commerce-apis-conclusion.mdx)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4063aea0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides weni by vtex understanding the core concepts in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/using-the-weni-by-vtex-cli)\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-cli-command-reference)\n\n[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/authenticating-with-your-weni-by-vtex-account)\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/managing-your-weni-by-vtex-projects)\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/working-with-weni-by-vtex-agents)\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/using-weni-run-to-execute-tool-tests)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/using-the-weni-by-vtex-cli)\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-cli-command-reference)\n\n[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/authenticating-with-your-weni-by-vtex-account)\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/managing-your-weni-by-vtex-projects)\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/working-with-weni-by-vtex-agents)\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/using-weni-run-to-execute-tool-tests)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides)\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\nUnderstanding the core concepts\n\nLearn the core concepts of the Weni by VTEX CLI.\n\nThis article contains the core concepts of the Weni by VTEX CLI.\n\n* [Active Agents](#active-agents)\n* [Passive Agents](#passive-agents)\n* [Contact Fields](#contact-fields)\n* [Credentials](#credentials)\n* [Tools](#tools)\n\n## Active Agents\n\n### Overview\n\nActive Agents are designed to proactively engage based on predefined rules and conditions. Unlike Passive Agents, which primarily react to user input, Active Agents can initiate actions or communications when specific criteria are met, often triggered by changes in data or system events.\n\nThe command to deploy an Active Agent remains the same:`weni project push agent_definition.yaml`\n\nHowever, the structure of the `agent_definition.yaml` is different to accommodate the rule-based behavior and pre-processing capabilities.\n\n### Creating an Active Agent\n\nAn Active Agent is also defined using a YAML file. Here's an example of the structure for an Active Agent:\n\n`1\n\nagents: \n\n2\n\n my_agent: \n\n3\n\n name: \"Status do Pedido\" \n\n4\n\n description: \"Agente de exemplo\" \n\n5\n\n rules: \n\n6\n\n status_aprovado: \n\n7\n\n display_name: \"Status Aprovado\" \n\n8\n\n template: \"template_status_aprovado\" \n\n9\n\n start_condition: \"Quando o status estiver 'aprovado'\" \n\n10\n\n source: \n\n11\n\n entrypoint: \"main.StatusAprovado\" \n\n12\n\n path: \"rules/status_aprovado\" \n\n13\n\n status_invoiced: \n\n14\n\n display_name: \"Status Invoiced\" \n\n15\n\n template: \"template_status_invoiced\" \n\n16\n\n start_condition: \"Quando o status estiver 'invoiced'\" \n\n17\n\n source: \n\n18\n\n entrypoint: \"main.StatusInvoiced\" \n\n19\n\n path: \"rules/status_invoiced\" \n\n20\n\n pre_processing: \n\n21\n\n source: \n\n22\n\n entrypoint: \"processing.PreProcessor\" \n\n23\n\n path: \"pre_processors/processor\" \n\n24\n\n result_examples_file: \"result_example.json\" \n\n`\n\n#### YAML Elements\n\nBelow are the key elements specific to or different for Active Agent definitions:\n\n`agents.<agent_id>`: The unique identifier for your agent.\n\n`name`: The display name of your agent.\n\n> Can have up to 55 characters.\n\n`description`: A description of the agent's purpose and capabilities.\n\n`rules`: A dictionary defining the rules that trigger the agent's actions. Each key within `rules` is a unique rule ID.\n\n* `rules.<rule_id>.display_name`: The human-readable name for the rule.\n* `rules.<rule_id>.template`: The template to be used when this rule is triggered. (Further details on templates might be needed here or in a separate section).\n* `rules.<rule_id>.start_condition`: A description of the condition that must be met for this rule to activate.\n* `rules.<rule_id>.source`: Defines the code to be executed when the rule is triggered. -`entrypoint`: The specific class and method (e.g., `main.StatusAprovado`) that will be executed. \n * `path`: The directory path where the rule's code is located (e.g., `rules/status_aprovado`).\n\n`pre_processing`: Defines a pre-processing step that can transform or prepare data before rules are evaluated.\n\n* `pre_processing.source`: Defines the code for the pre-processing logic. -`entrypoint`: The class and method for pre-processing (e.g., `processing.PreProcessor`). \n * `path`: The directory path for the pre-processing code (e.g., `pre_processors/processor`).\n* `pre_processing.result_examples_file`: Required. Path to a JSON file containing examples of the data output from pre-processing. The format is an array of objects.\n\n#### Result Example JSON Format\n\nThe `result_example.json` file should follow this structure:\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"urn\": \"<identifier_for_contact>\", \n\n4\n\n \"data\": { \n\n5\n\n \"key1\": \"value1\", \n\n6\n\n \"key2\": \"value2\" \n\n7\n\n // ... other data fields relevant to the example \n\n8\n\n } \n\n9\n\n }, \n\n10\n\n { \n\n11\n\n \"urn\": \"<another_contact_identifier>\", \n\n12\n\n \"data\": { \n\n13\n\n \"fieldA\": \"dataA\", \n\n14\n\n \"fieldB\": \"dataB\" \n\n15\n\n } \n\n16\n\n } \n\n17\n\n // ... more examples \n\n18\n\n] \n\n`\n\nEach object in the array represents a test case or an example scenario.\n\n* `urn`: A unique identifier for the contact (e.g., a phone number, user ID).\n* `data`: An object containing the data relevant to this specific example. The structure of this `data` object will depend on your agent's specific needs and the information it processes.\n\n### Basic Structure\n\nThe project structure for an Active Agent might look like this, incorporating rules and pre-processing logic:\n\n`1\n\nyour-project-name/ \n\n2\n\n├── rules/ \n\n3\n\n│ ├── status_aprovado/ \n\n4\n\n│ │ └── main.py \n\n5\n\n│ │ └── requirements.txt \n\n6\n\n│ └── status_invoiced/ \n\n7\n\n│ └── main.py \n\n8\n\n│ └── requirements.txt \n\n9\n\n├── pre_processors/ \n\n10\n\n│ └── processor/ \n\n11\n\n│ └── processing.py \n\n12\n\n│ └── requirements.txt \n\n13\n\n├── agent_definition.yaml \n\n14\n\n└── result_example.json \n\n`\n\nThis structure helps organize the different components of your Active Agent.\n\n## Passive Agents\n\nThis page describes Passive Agents, which are AI-powered workers designed to operate autonomously by reacting to user input or specific triggers within a defined context.\n\n### Overview\n\nPassive Agents are AI-powered workers designed to operate autonomously within specific contexts, using generative AI to make decisions based on specified problems. In the context of Weni by VTEX CLI, these agents are specifically optimized for customer service operations, serving as the frontline communication interface between companies and their customers by responding to inquiries and executing tasks based on their configured skills.\n\nKey features:\n\n* Autonomous decision-making capabilities\n* Context-specific operations\n* Built-in generative AI processing\n* Customer service optimization\n\nWith Weni by VTEX CLI, you can define and deploy multiple agents that work together to solve real-world problems with precision, quality, and security. These agents can be equipped with various tools that enable them to interact with the external world within defined boundaries.\n\n### Creating a Passive Agent\n\nA Passive Agent consists of an agent definition. In Weni by VTEX CLI, this definition is made using a YAML file, where you can specify its behavior, instructions, and skills.\n\nHere is an example of how you can define your agent in a YAML file:\n\n`1\n\nagents: \n\n2\n\n cep_agent: \n\n3\n\n name: \"CEP Agent\" \n\n4\n\n description: \"Weni's CEP agent\" \n\n5\n\n instructions: \n\n6\n\n - \"You are an expert in providing addresses to the user based on a postal code provided by the user\" \n\n7\n\n - \"The user will send a ZIP code (postal code) and you must provide the address corresponding to this code.\" \n\n8\n\n guardrails: \n\n9\n\n - \"Don't talk about politics, religion or any other sensitive topic. Keep it neutral.\" \n\n10\n\n tools: \n\n11\n\n - get_address: \n\n12\n\n name: \"Get Address\" \n\n13\n\n source: \n\n14\n\n path: \"tools/get_address\" \n\n15\n\n entrypoint: \"main.GetAddress\" \n\n16\n\n path_test: \"test_definition.yaml\" \n\n17\n\n description: \"Function to get the address from the postal code\" \n\n18\n\n parameters: \n\n19\n\n - cep: \n\n20\n\n description: \"postal code of a place\" \n\n21\n\n type: \"string\" \n\n22\n\n required: true \n\n23\n\n contact_field: true \n\n`\n\n#### YAML Elements\n\n\\=== \"Agent\"\n\n`Name`: The name of your agent that will be displayed in the Weni by VTEX Platform.\n\n> Can have up to 55 characters.\n\n`Credentials`: The credentials used in the tools you define for your agent. For more detailed information about this definition, see [Authenticating with your Weni by VTEX account](authentication.md).\n\n`Description`: Important information about your agent, where you can describe its purpose, capabilities, and other relevant details.\n\n`Instructions`: Here you can define rules and guidelines that your agent should follow.\n\n> Must have a minimum of 40 characters.\n\n`Guardrails`: You can list boundaries and limitations for your agent, such as topics it should not discuss.\n\n> Must have a minimum of 40 characters.\n\n\\=== \"Tool\"\n\n`Name`: The name of the tool that will be associated with the agent in the Weni by VTEX Platform.\n\n> Can have up to 40 characters.\n\n`Source`: The location or path where the tool can be found. It contains three important elements:\n\n* `path`: The directory path where your tool's code is located. This is typically a relative path from the root of your project.\n* `entrypoint`: The specific class that will be executed when the tool is called. It follows the format \"file\\_name.ClassName\". You can see a practical example of the tool implementation for this entrypoint in the [Tools section](#tools), where the GetAddress class from this example is implemented.\n* `path_test`: The location of the test file for your tool, which contains test cases to validate the tool's functionality.\n\n`Description`: Information about the tool, including its purpose and objectives.\n\n`Parameters`: The parameters or variables used in your agent's tool.\n\n* `description`: A clear explanation of what the parameter is used for and what kind of data it expects.\n* `type`: The data type of the parameter (one of: string, number, integer, boolean, array).\n* `required`: A boolean value (`true` or `false`) indicating whether the parameter must be provided for the tool to function properly. If set to true, the agent will ask the user for this information if it's not available before proceeding with the request.\n* `contact_field`: Specifies if the parameter should be stored as a contact field in the user's profile for future reference. If set to true, the respective parameter will become information that persists for the user integrated with the Weni by VTEX Platform. This brings benefits to the user experience because in future interactions, your agent may not need to request this information from the user again. Read more about contact fields in [Contact Fields](./contact-fields.md).\n\n### Basic Structure\n\nThe basic structure of your project should consist of your agent definition written in YAML and your agent's tools organized into directories. It is not mandatory to organize your tools in a 'tools' directory, but it is highly recommended as a best practice.\n\nBased on the definition example below:\n\n`1\n\nagents: \n\n2\n\n cep_agent: \n\n3\n\n name: \"CEP Agent\" \n\n4\n\n description: \"Weni's CEP agent\" \n\n5\n\n instructions: \n\n6\n\n - \"You are an expert in providing addresses to the user based on a postal code provided by the user\" \n\n7\n\n - \"The user will send a ZIP code (postal code) and you must provide the address corresponding to this code.\" \n\n8\n\n guardrails: \n\n9\n\n - \"Don't talk about politics, religion or any other sensitive topic. Keep it neutral.\" \n\n10\n\n tools: \n\n11\n\n - get_address: \n\n12\n\n name: \"Get Address\" \n\n13\n\n source: \n\n14\n\n path: \"tools/get_address\" \n\n15\n\n entrypoint: \"main.GetAddress\" \n\n16\n\n path_test: \"test_definition.yaml\" \n\n17\n\n description: \"Function to get the address from the postal code\" \n\n18\n\n parameters: \n\n19\n\n - cep: \n\n20\n\n description: \"postal code of a place\" \n\n21\n\n type: \"string\" \n\n22\n\n required: true \n\n23\n\n contact_field: true \n\n`\n\nYour project should have the following structure:\n\n`1\n\nyour-project-name/ \n\n2\n\n├── tools/ \n\n3\n\n│ ├── get_address/main.py \n\n4\n\n└── agent_definition.yaml \n\n`\n\n## Contact Fields\n\n### Overview\n\nContact fields are persistent information about contacts who interact with your agents. By enabling contact fields in your tools, you elevate the user experience to a new level, as your agents can interact with the Weni by VTEX Platform to accurately obtain information about the contact.\n\n### How Contact Fields Work\n\nWhen you mark a parameter as a contact field in your tool definition, that information becomes persistent in the user's profile within the Weni by VTEXPlatform. This creates several advantages:\n\n1. **Improved User Experience**: Users don't need to repeatedly provide the same information in future interactions\n2. **Personalized Interactions**: Agents can address users with personalized information from previous conversations\n3. **Streamlined Conversations**: Reduces the number of questions agents need to ask, making interactions more efficient\n\n### Implementing Contact Fields\n\nTo implement a contact field in your tool, you need to set the `contact_field` parameter to `true` in your agent definition YAML file:\n\n`1\n\nparameters: \n\n2\n\n - tool_parameter: \n\n3\n\n description: \"User's full name\" \n\n4\n\n type: \"string\" \n\n5\n\n required: true \n\n6\n\n contact_field: true \n\n`\n\nWhen this parameter is processed during a conversation, the information provided by the user will be:\n\n* Stored in the Weni by VTEX Platform associated with that specific contact\n* Available for retrieval and update in future interactions\n* Accessible to all agents that have permission to view this contact field\n\n### Best Practices\n\nWhen implementing contact fields, consider the following best practices:\n\n* **Only store relevant information**: Not every parameter is necessarily a contact field; focus on information that will be useful in future interactions. Consider whether the parameter contains information important enough to be persisted for the contact.\n* **Use descriptive parameter names**: This helps maintain organization when multiple contact fields are in use\n* **Validate data before storing**: Ensure the information is in the correct format before saving it as a contact field\n\n### Example Use Cases\n\nContact fields are particularly useful for:\n\n* **Personal information**: Names, addresses, preferences\n* **Account details**: Customer IDs, subscription types\n* **Context-specific data**: Preferred language, communication preferences\n* **Historical information**: Previous purchases, service history\n\nBy effectively utilizing contact fields, you can create more intelligent, context-aware agents that provide a seamless experience for your users.\n\n## Credentials\n\nCredentials are confidential information that your agents can use when invoking a specific tool. To fully understand how to incorporate credentials into your agents, we recommend reading this entire content and the following complementary resources: [Agents](./agents.md) and [tools](./tools.md).\n\nCredentials are extremely important at two stages of your agents' development cycle:\n\n* For local testing of tools during development\n* For your agent to be used in production on channels integrated with the Weni by VTEX platform, such as WhatsApp or any other\n\n### Credential Structure\n\nIn your agent definition file (YAML), credentials are defined in the `credentials` section and follow this structure:\n\n`1\n\nagents: \n\n2\n\n my_agent: \n\n3\n\n credentials: \n\n4\n\n API_KEY: \n\n5\n\n label: \"API Key\" \n\n6\n\n placeholder: \"your-api-key-here\" \n\n7\n\n is_confidential: true \n\n8\n\n API_SECRET: \n\n9\n\n label: \"API Secret\" \n\n10\n\n placeholder: \"your-api-secret-here\" \n\n11\n\n BASE_URL: \n\n12\n\n label: \"Base URL\" \n\n13\n\n placeholder: \"https://api.example.com\" \n\n14\n\n is_confidential: false \n\n`\n\nEach credential has the following attributes:\n\n* **label**: Human-readable name that will be displayed in the Weni by VTEX Platform interface\n* **placeholder**: Example text or hint about what should be entered\n* **is\\_confidential**: Indicates whether the credential contains sensitive information (defaults to `true` if not specified)\n\n### Credentials in Production Environment\n\nWhen your agent is deployed on the Weni by VTEX Platform, credentials are securely managed by the system. This ensures that sensitive information, such as API keys and access tokens, is stored and transmitted securely.\n\n#### How to Configure Credentials for Production\n\n1. **Define credentials in the YAML file**: Specify all necessary credentials in the `credentials` section of your agent definition file.\n2. **Deploy your agent**: When pushing your agent to the Weni by VTEX Platform using the CLI, the system will automatically detect the credentials defined in your YAML file.\n3. **Configure values in the interface**: Administrators will be able to configure the actual credential values through the Weni by VTEX Platform interface, without needing to modify the code.\n4. **Associate credentials with tools**: Ensure that each tool that needs credentials is correctly configured to access them through the `context.credentials` object.\n\n> **Note**: When you assign your agent in the Weni by VTEX Platform, the credentials defined in your YAML file will be displayed in the interface for configuration. For example, if you have the following agent definition:\n> \n> `1\n> \n> agents: \n> \n> 2\n> \n> cep_agent: \n> \n> 3\n> \n> credentials: \n> \n> 4\n> \n> api_key: \n> \n> 5\n> \n> label: \"API Key\" \n> \n> 6\n> \n> placeholder: \"Enter your API key\" \n> \n> 7\n> \n> name: \"CEP Agent\" \n> \n> 8\n> \n> description: \"Weni's CEP agent with components\" \n> \n> 9\n> \n> instructions: \n> \n> 10\n> \n> - \"You are an expert in providing addresses to the user based on a postal code provided by the user\" \n> \n> 11\n> \n> - \"The user will send a ZIP code (postal code) and you must provide the address corresponding to this code.\" \n> \n> 12\n> \n> guardrails: \n> \n> 13\n> \n> - \"Don't talk about politics, religion or any other sensitive topic. Keep it neutral.\" \n> \n> 14\n> \n> tools: \n> \n> 15\n> \n> - get_address: \n> \n> 16\n> \n> name: \"Get Address\" \n> \n> 17\n> \n> source: \n> \n> 18\n> \n> path: \"tools/get_address\" \n> \n> 19\n> \n> entrypoint: \"main.GetAddress\" \n> \n> 20\n> \n> path_test: \"test_definition.yaml\" \n> \n> 21\n> \n> description: \"Function to get the address from the postal code\" \n> \n> 22\n> \n> parameters: \n> \n> 23\n> \n> - cep: \n> \n> 24\n> \n> description: \"postal code of a place\" \n> \n> 25\n> \n> type: \"string\" \n> \n> 26\n> \n> required: true \n> \n> 27\n> \n> contact_field: true \n> \n> `\n> \n> After running the command `weni project push agent_definition.yaml` to upload your agent to your project on the Weni by VTEX Platform, you'll find your agent in the Agent Builder gallery. When you select and assign this agent, you'll be prompted to enter the actual values for the credentials you defined (in this case, the API Key).\n\n>> An error occurred while loading the image https://github.com/vtexdocs/dev-portal-content/main/docs/guides/Weni-by-VTEX/CLI/assets/agent-builder-gallery.png\n\n```` 1\n\n>  \n\n2\n\n \n3\n\n> Enter you credentials: \n\n4\n\n \n5\n\n>  \n\n6\n\n \n7\n\n#### Security in Production \n\n8\n\n \n9\n\nIn the Weni by VTEX Platform, credentials are: \n\n10\n\n \n11\n\n- Stored in encrypted form \n\n12\n\n- Never exposed in logs or user interfaces \n\n13\n\n \n14\n\n### Credentials for Local Testing \n\n15\n\n \n16\n\nDuring development and local testing of your tools, you'll need to provide credentials for your tools to work correctly without depending on the Weni by VTEX Platform infrastructure. \n\n17\n\n \n18\n\n#### Configuring Credentials for Local Development \n\n19\n\n \n20\n\nFor local testing, the CLI reads a `.env` file located in the tool's `source.path` directory. Define the same credential names that are declared in your agent definition. This mirrors how credentials are injected in production. \n\n21\n\n \n22\n\nFor example, if your CEP Agent definition has the following credentials: \n\n23\n\n \n24\n\n```yaml \n\n25\n\nagents: \n\n26\n\n cep_agent: \n\n27\n\n credentials: \n\n28\n\n api_key: \n\n29\n\n label: \"API Key\" \n\n30\n\n placeholder: \"Enter your API key\" \n\n31\n\n # Rest of the agent definition... \n\n ````\n\nCreate a `.env` file inside the tool folder (e.g. `tools/get_address/.env`) with:\n\n`1\n\napi_key=your-development-api-key \n\n`\n\n## Tools\n\n### What Are Tools?\n\nTools are powerful tools available to your agent that enable it to interact with the external environment and the real world. Think of tools as superpowers for your agent - you can create virtually any capability your agent needs by writing Python code that implements your specific business logic!\n\n### Why Tools Matter\n\nTools transform your agent from a simple conversational interface into a powerful tool that can:\n\n* Fetch real-time data from external APIs\n* Perform complex calculations and data processing\n* Interact with databases and storage systems\n* Execute custom business logic specific to your needs\n* Integrate with third-party services and platforms\n* Automate tasks and workflows\n\n### Using Tools in Your Agent\n\nOnce you've created a tool, you can relate it to your agent by defining it in your agent's YAML configuration file, as demonstrated in the [Agents](./agents.md) documentation page. The agent will automatically detect when to use the tool based on the context of the conversation.\n\nBy creating custom tools, you can extend your agent's capabilities to handle specific tasks relevant to your use case, making your agent truly tailored to your business needs.\n\n### Tool Example: Address Lookup\n\nHere's an example of a tool that allows an agent to interact with the real world to precisely obtain information about a postal code (CEP in Brazil):\n\n`1\n\nfrom weni import Tool \n\n2\n\nfrom weni.context import Context \n\n3\n\nfrom weni.responses import TextResponse \n\n4\n\nimport requests \n\n5\n\n \n6\n\nclass GetAddress(Tool): \n\n7\n\n def execute(self, context: Context) -> TextResponse: \n\n8\n\n \n9\n\n cep = context.parameters.get(\"cep\", \"\") \n\n10\n\n \n11\n\n print(cep) \n\n12\n\n \n13\n\n address_response = self.get_address_by_cep(cep=cep) \n\n14\n\n \n15\n\n print(address_response) \n\n16\n\n \n17\n\n return TextResponse(data=address_response) \n\n18\n\n \n19\n\n def get_address_by_cep(self, cep): \n\n20\n\n url = f\"https://viacep.com.br/ws/{cep}/json/\" \n\n21\n\n \n22\n\n response = requests.get(url) \n\n23\n\n \n24\n\n return response.json() \n\n`\n\n### Code Explanation\n\n\\=== \"For Beginners\"\n\nIf you're new to programming, here's a simpler explanation of what this code does:\n\n1. **Imports**: First, we bring in the tools we need: \n * `Tool`: The base class that gives our tool its core functionality \n * `Context`: Holds information about the conversation \n * `TextResponse`: Helps us send text back to the user \n * `requests`: A tool that lets us get information from websites\n2. **Class Definition**: We create a new tool called `GetAddress` that can look up addresses.\n3. **Execute Method**: This is the main part that runs when someone uses the tool: \n * It gets the postal code (CEP) that the user provided \n * It prints the CEP to help with debugging \n * It calls another function to find the address for that CEP \n * It returns the address information to the user\n4. **Helper Method**: The `get_address_by_cep` function: \n * Takes a postal code as input \n * Creates a web address (URL) to look up that postal code \n * Sends a request to a website that knows about addresses \n * Gets back information about the address and returns it\n\nThink of this tool like a helper that knows how to look up addresses in a phone book when you give it a postal code!\n\n\\=== \"For Experienced Developers\"\n\nFor those familiar with Python and API development:\n\n1. **Imports**: We import the necessary Weni by VTEX framework classes (`Tool`, `Context`, `TextResponse`) and the `requests` library for HTTP operations.\n2. **Class Definition**: We define a `GetAddress` class that inherits from the base `Tool` class, which provides the framework integration.\n3. **Execute Method**: This is the entry point that the Weni by VTEX framework calls: \n * It extracts the \"cep\" parameter from the context object using a get() with a default empty string \n * It includes debug print statements for logging \n * It delegates the actual API call to a separate method for better separation of concerns \n * It returns a `TextResponse` object with the JSON data from the API\n4. **Helper Method**: The `get_address_by_cep` method: \n * Constructs the ViaCEP API endpoint URL with string interpolation \n * Makes a GET request to the external API \n * Returns the parsed JSON response directly \n * Note that this implementation is minimal and lacks error handling for production use\n\nThis implementation follows a simple separation of concerns pattern but could be enhanced with error handling, input validation, response formatting, and proper logging for production use.\n\n### Creating Your Own Tools\n\nTo create your own tool:\n\n1. **Define Your Tool Class**: Create a new Python class that inherits from `Tool`\n2. **Implement the Execute Method**: Override the `execute(self, context: Context)` method with your business logic\n3. **Add Helper Methods**: Separate concerns by breaking down complex logic into helper methods\n4. **Implement Error Handling**: Add robust error handling for API calls, data processing, and edge cases\n5. **Add Logging**: Include appropriate logging for monitoring and debugging\n6. **Write Tests**: Create comprehensive test cases using the test file specified in `path_test`\n7. **Configure Your Tool**: Add your tool to your agent's YAML configuration with appropriate parameters and any credentials required by your tool.\n\n### Tools with Credentials\n\nWhen your tool needs to interact with external services that require authentication, you'll need to use credentials or secrets. The Weni by VTEX framework provides a secure way to manage these credentials through the `Context` object.\n\n#### How to Access Credentials\n\nCredentials are accessed through the `Context` object that is passed to your tool's `execute` method. This ensures that sensitive information is handled securely and isn't hardcoded in your tool's code.\n\nHere's an example of how to modify our `GetAddress` tool to use credentials for an API that requires authentication:\n\n`1\n\nfrom weni import Tool \n\n2\n\nfrom weni.context import Context \n\n3\n\nfrom weni.responses import TextResponse \n\n4\n\nimport requests \n\n5\n\n \n6\n\nclass GetAddressWithAuth(Tool): \n\n7\n\n def execute(self, context: Context) -> TextResponse: \n\n8\n\n cep = context.parameters.get(\"cep\", \"\") \n\n9\n\n \n10\n\n api_key = context.credentials.get(\"api_key\") \n\n11\n\n \n12\n\n address_response = self.get_address_by_cep(cep=cep, api_key=api_key) \n\n13\n\n \n14\n\n return TextResponse(data=address_response) \n\n15\n\n \n16\n\n def get_address_by_cep(self, cep, api_key): \n\n17\n\n url = f\"https://viacep.com.br/ws/{cep}/json/\" \n\n18\n\n \n19\n\n headers = { \n\n20\n\n \"Authorization\": f\"Bearer {api_key}\" \n\n21\n\n } \n\n22\n\n \n23\n\n response = requests.get(url, headers=headers) \n\n24\n\n \n25\n\n return response.json() \n\n`\n\n#### Configuring Credentials in Your Agent Definition\n\nTo make credentials available to your tool, you need to define them in your agent's YAML configuration file. Here's an example:\n\n`1\n\nagents: \n\n2\n\n cep_agent: \n\n3\n\n credentials: \n\n4\n\n api_key: \n\n5\n\n label: \"API Key\" \n\n6\n\n placeholder: \"Api Key\" \n\n7\n\n name: \"CEP Agent\" \n\n8\n\n description: \"Weni's CEP agent\" \n\n9\n\n instructions: \n\n10\n\n - \"You are an expert in providing addresses to the user based on a postal code provided by the user\" \n\n11\n\n - \"The user will send a ZIP code (postal code) and you must provide the address corresponding to this code.\" \n\n12\n\n guardrails: \n\n13\n\n - \"Don't talk about politics, religion or any other sensitive topic. Keep it neutral.\" \n\n14\n\n tools: \n\n15\n\n - get_address: \n\n16\n\n name: \"Get Address\" \n\n17\n\n source: \n\n18\n\n path: \"tools/get_address\" \n\n19\n\n entrypoint: \"main.GetAddressWithAuth\" \n\n20\n\n path_test: \"test_definition.yaml\" \n\n21\n\n description: \"Function to get the address from the postal code\" \n\n22\n\n parameters: \n\n23\n\n - cep: \n\n24\n\n description: \"postal code of a place\" \n\n25\n\n type: \"string\" \n\n26\n\n required: true \n\n27\n\n contact_field: true \n\n`\n\n> **Highly Recommended**: For a comprehensive understanding of how credentials work in production environments and local testing, please read the [Credentials](./credentials.md) documentation page. This will help you properly manage sensitive information and understand the different approaches for development and production environments.\n\n#### Best Practices for Handling Credentials\n\nWhen working with credentials in your tools:\n\n1. **Never hardcode credentials** in your tool's code.\n2. **Always access credentials through the Context object**.\n3. **Use environment variables** for local development and testing.\n4. **Implement proper error handling** for cases where credentials might be missing or invalid.\n\nBy following these practices, you can create secure tools that interact with authenticated services while keeping sensitive information protected.\n\n### Best Practices for Tools\n\nWhen creating tools, follow these best practices:\n\n* **Single Responsibility**: Each tool should have a clear, focused purpose\n* **Comprehensive Error Handling**: Implement robust error handling for all external calls and edge cases\n* **Input Validation**: Validate all input parameters before processing\n* **Security Considerations**: Handle sensitive data appropriately and follow security best practices\n* **Testability**: Design your tools to be easily testable with both unit and integration tests\n* **Version Control**: Use a GitHub repository to version your tools, allowing you to track changes, collaborate with others, and easily roll back to previous versions if needed\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Weni-by-VTEX/CLI/weni-by-vtex-understanding-the-core-concepts.md)\n\n[Managing your Weni by VTEX projects« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts//docs/guides/managing-your-weni-by-vtex-projects)[Working with Weni by VTEX agentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts//docs/guides/working-with-weni-by-vtex-agents)\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\n\nON THIS PAGE\n\n[Active Agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23active-agents)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23overview)[Creating an Active Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23creating-an-active-agent)[Basic Structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23basic-structure)\n\n[Passive Agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23passive-agents)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23overview)[Creating a Passive Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23creating-a-passive-agent)[Basic Structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23basic-structure)\n\n[Contact Fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23contact-fields)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23overview)[How Contact Fields Work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23how-contact-fields-work)[Implementing Contact Fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23implementing-contact-fields)[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23best-practices)[Example Use Cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23example-use-cases)\n\n[Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23credentials)\n\n[Credential Structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23credential-structure)[Credentials in Production Environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23credentials-in-production-environment)\n\n[Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23tools)\n\n[What Are Tools?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23what-are-tools)[Why Tools Matter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23why-tools-matter)[Using Tools in Your Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23using-tools-in-your-agent)[Tool Example: Address Lookup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23tool-example-address-lookup)[Code Explanation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23code-explanation)[Creating Your Own Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23creating-your-own-tools)[Tools with Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23tools-with-credentials)[Best Practices for Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23best-practices-for-tools)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Weni-by-VTEX/CLI/weni-by-vtex-understanding-the-core-concepts.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Active Agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23active-agents)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23overview)[Creating an Active Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23creating-an-active-agent)[Basic Structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23basic-structure)\n\n[Passive Agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23passive-agents)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23overview)[Creating a Passive Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23creating-a-passive-agent)[Basic Structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23basic-structure)\n\n[Contact Fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23contact-fields)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23overview)[How Contact Fields Work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23how-contact-fields-work)[Implementing Contact Fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23implementing-contact-fields)[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23best-practices)[Example Use Cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23example-use-cases)\n\n[Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23credentials)\n\n[Credential Structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23credential-structure)[Credentials in Production Environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23credentials-in-production-environment)\n\n[Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23tools)\n\n[What Are Tools?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23what-are-tools)[Why Tools Matter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23why-tools-matter)[Using Tools in Your Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23using-tools-in-your-agent)[Tool Example: Address Lookup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23tool-example-address-lookup)[Code Explanation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23code-explanation)[Creating Your Own Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23creating-your-own-tools)[Tools with Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23tools-with-credentials)[Best Practices for Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-understanding-the-core-concepts/docs/guides/weni-by-vtex-understanding-the-core-concepts%23best-practices-for-tools)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_fdcbf37c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides brands in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/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/brands/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/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/brands/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/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/brands/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/brands/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/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/brands/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/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/brands/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/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/brands/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/brands/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/catalog-integration)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands)\n\nBrands\n\n[Brands](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/7i3sB8fgkqUp5NoH5yJtfh) work as product attributes that help end customers to identify a product and the business behind it.\n\nA product can only be associated with a single brand. Each product needs to be associated with a brand to exist. Therefore, creating a Brand is a mandatory step when configuring your Catalog. Usually, it is the second step for catalog integration, after creating categories. For more information on Catalog structure and integration flow at VTEX, check our [Catalog overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/catalog-overview).\n\n## Create a brand\n\nTo create a brand, use the [Create Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-brand) endpoint. In this endpoint, the request and the response follow the same structure. See the example below:\n\n**Request and response body example**\n\n`1\n\n{ \n\n2\n\n \"Id\": 2000013, \n\n3\n\n \"Name\": \"Orma Carbon\", \n\n4\n\n \"Text\": \"Orma Carbon\", \n\n5\n\n \"Keywords\": \"orma\", \n\n6\n\n \"SiteTitle\": \"Orma Carbon\", \n\n7\n\n \"Active\": true, \n\n8\n\n \"MenuHome\": true, \n\n9\n\n \"AdWordsRemarketingCode\": \"\", \n\n10\n\n \"LomadeeCampaignCode\": \"\", \n\n11\n\n \"Score\": null, \n\n12\n\n \"LinkId\": \"orma-carbon\" \n\n13\n\n} \n\n`\n\n> Do not insert empty spaces at the end of the brand name. VTEX interprets that as a new brand, causing duplication.\n\n> You must activate the brand, otherwise the associated products will not be indexed and thereafter will not be displayed on the website.\n\n## Edit a brand\n\nYou can edit an existing brand by using the [Update Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-put-brand) endpoint with the same request body structure as to create a brand. The only non-editable information is the Brand ID.\n\n## Get brand list\n\nYou can get information about all the brands configured in your store by placing a request to one of the following endpoints:\n\n* [Get Brand List](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-brand-list): Full list of brands in your store. This route's response is limited to 20k results. If you need to obtain more results, please use the [Get Brand List per page](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/brandlistperpage)endpoint instead to get a paginated response.\n* [Get Brand List per page](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/brandlistperpage): Paginated list of brands in your store.\n\n## Get brand\n\nYou can retrieve information about a specific brand by making a request to [Get Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-brand).\n\n## Delete a brand\n\nTo delete a brand, use the [Delete Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-delete-brand) endpoint. This action is permanent and cannot be undone.\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/brands.md)\n\n[Categories« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands//docs/guides/categories)[ProductsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands//docs/guides/products)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Create a brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands%23create-a-brand)\n\n[Edit a brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands%23edit-a-brand)\n\n[Get brand list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands%23get-brand-list)\n\n[Get brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands%23get-brand)\n\n[Delete a brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands%23delete-a-brand)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/brands.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Create a brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands%23create-a-brand)\n\n[Edit a brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands%23edit-a-brand)\n\n[Get brand list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands%23get-brand-list)\n\n[Get brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands%23get-brand)\n\n[Delete a brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands/docs/guides/brands%23delete-a-brand)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4a60be8d
|
[
{
"role": "system",
"content": "You are a VTEX 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 updating the cli package version in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-updating-the-cli-package-version/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-updating-the-cli-package-version/docs/api-reference)\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-updating-the-cli-package-version/docs/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-updating-the-cli-package-version/docs/storefront-development)\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-updating-the-cli-package-version/docs/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-updating-the-cli-package-version/docs/troubleshooting)\n\n[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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/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-updating-the-cli-package-version/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/guides/faststore)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/guides/faststore/developer-tools-overview)\n\nUpdating the '@faststore/cli' package version\n\nIf you need to update the [@faststore/cli](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package, follow these instructions.\n\n> Since the publication of [this release note](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency), the `@faststore/core` package now depends on the `@faststore/cli` package. Before updating the `@faststore/cli` package, make sure to check if this package is already listed in your dependencies. If not, check out the [release note](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency) related to this change.\n\n1. Open your FastStore codebase in the code editor of your preference.\n2. Open the terminal and run the following: \n`1 \nyarn add @faststore/cli@latest \n`\n3. Run `yarn dev` to sync the changes to your project.\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/updating-the-cli-package-version.mdx)\n\n[FastStore CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/guides/faststore/developer-tools-faststore-cli)[StylingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-updating-the-cli-package-version/docs/guides/faststore/styling-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/updating-the-cli-package-version.mdx)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_45482e17
|
[
{
"role": "system",
"content": "You are a VTEX 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 slider 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-slider-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-slider-layout/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/guides/layout-apps)\n\nSlider Layout\n\nOfficial extension\n\nVersion: 0.24.8\n\nLatest version: 0.24.8\n\n[](#contributors-)\n\nSlider Layout is a flexible solution for building block sliders in VTEX Store Framework, such as a carousel component.\n\n\n\n> _To use the Slider layout as a substitute for the [Carousel app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/carousel), read the [Building a Carousel through lists and Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout) documentation._\n\n## Google Analytics 4 Integration\n\nSlider Layout enables you to integrate your component with [Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4). The integration happens through the [GA4 view\\_promotion](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fpromotion) event, which is typically associated with the promotion banners carousel displayed by the Slider Layout.\n\nBy integrating with Google Analytics 4, you can set the `Product ID` and `Product Name`, and position of your promotion on [Site Editor](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/site-editor-overview--299Dbeb9mFczUTyNQ9xPe1) to be shown on a Google Analytics dashboard.\n\nTo set this up, go to the VTEX Admin, access **Storefront > Site Editor**, and open the image settings of the internal promotion you want to track. These settings are displayed on the right side of the page.\n\n\n\n> For more information about managing your page content, read [Managing page and template content](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-page-and-template-content--3tMbx6HXy4Fy5r9EhboG37).\n\nAfter setup, Google Analytics can track your internal promotions and generate reports of their views, clicks, click-through rate, conversions, and revenue.\n\n## Configuration\n\n1. Add the `slider-layout` app to your theme dependencies in the `manifest.json` file:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.slider-layout\": \"0.x\" \n\n3\n\n} \n\n`\n\nNow, you can use all blocks exported by the `slider-layout` app. See the complete list below:\n\n| Block name | Description |\n| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| slider-layout |  Builds block sliders for your store through its children list blocks. |\n| slider-layout-group | Enables you to keep a group of slider-layout blocks synched with each other. For more information about this, see the Advanced configuration section below. |\n\n1. Add the `slider-layout` block to your template. For example:\n\n`1\n\n \"slider-layout#text-test\": { \n\n2\n\n \"props\": { \n\n3\n\n \"itemsPerPage\": { \n\n4\n\n \"desktop\": 1, \n\n5\n\n \"tablet\": 1, \n\n6\n\n \"phone\": 1 \n\n7\n\n }, \n\n8\n\n \"infinite\": true, \n\n9\n\n \"showNavigationArrows\": \"desktopOnly\", \n\n10\n\n \"blockClass\": \"carousel\" \n\n11\n\n }, \n\n12\n\n \"children\": [\"rich-text#1\", \"rich-text#2\", \"rich-text#3\"] \n\n13\n\n }, \n\n14\n\n \n15\n\n \"rich-text#1\": { \n\n16\n\n \"props\": { \n\n17\n\n \"text\": \"Test1\" \n\n18\n\n } \n\n19\n\n }, \n\n20\n\n \"rich-text#2\": { \n\n21\n\n \"props\": { \n\n22\n\n \"text\": \"Test2\" \n\n23\n\n } \n\n24\n\n }, \n\n25\n\n \"rich-text#3\": { \n\n26\n\n \"props\": { \n\n27\n\n \"text\": \"Test3\" \n\n28\n\n } \n\n29\n\n }, \n\n`\n\n| Prop name | Type | Description | Default value |\n| -------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |\n| label | string | aria-label attribute value to be used by the <Slider/> component when rendered. The aria-label value should explicitly tell users what the inspected HTML element does. | slider |\n| showNavigationArrows | enum | Indicates when navigation arrows should be rendered. Possible values are: mobileOnly, desktopOnly, always, or never. | always |\n| showPaginationDots | enum | Indicates when pagination dots should be rendered. Possible values are: mobileOnly, desktopOnly, always, or never. | always |\n| infinite | boolean | Determines whether the slider should be infinite (true) or not (false). When this prop is set as false, the slider will have an explicit end for users. | false |\n| usePagination | boolean | Determines whether the slider should use slide pages (true) or not (false). When this prop is set as false, the slider will use smooth scrolling for slide navigation instead of arrows. | true |\n| itemsPerPage | object | The number of slider items to be shown on each type of device. For more information about this, see the itemsPerPage object section below. | { desktop: 5, tablet: 3, phone: 1 } |\n| navigationStep | number / enum | The number of slider items that should be displayed when users click one of the slider arrows. It is also possible to set this prop value as page, meaning that the number of slider items to be displayed when one of the arrows is clicked is equal to the number of slider items set per page (in the itemsPerPage prop). | page |\n| slideTransition | object | Controls the transition animation between slides based on [CSS attributes](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/CSS/transition). For more information about this, see the slideTransition object section below. | { speed: 400, delay: 0, timing: '' } |\n| autoplay | object | Controls the autoplay feature behavior. For more information about this, see the autoplay object section below. | undefined |\n| fullWidth | boolean | Determines whether the slides should occupy the full page width, making the arrows appear on top of them (true) or not (false). | true |\n| arrowSize | number / object | Slider arrows size (height and width) in pixels. This is a responsive prop, which means you can pass to it an object with different values for each breakpoint (desktop, mobile, tablet, and phone). | 25 |\n| centerMode | enum / object | Defines positioning of the slider elements on the screen. Possible values are: center (elements are centered, allowing users to see a peek of the previous and next slides), to-the-left (aligns elements to the left side, allowing users to see a peek of the next slide, but not the previous one), and disabled (disables the feature, rendering elements on the whole screen without showing a peek of the previous and next slides). Note: This is a responsive prop, which means you can pass to it an object with different values for each breakpoint (desktop, mobile, tablet, and phone). | disabled |\n| centerModeSlidesGap | number | Number of pixels between slides when centerMode is set to center or to-the-left. | undefined |\n\n* **`itemsPerPage` object**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | -------------------------------------------------------- | ------------- |\n| desktop | number | The number of slides to be displayed on desktop devices. | 5 |\n| tablet | number | The number of slides to be displayed on tablet devices. | 3 |\n| phone | number | The number of slides to be displayed on phone devices. | 1 |\n\n* **`slideTransition` object**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------- | ------------- |\n| speed | number | Transition speed (in ms). | 400 |\n| delay | number | Delay between slide transition (in ms). | 0 |\n| timing | string | Timing function. | '' |\n\n* **`autoplay` object**\n\n| Prop name | Type | Description | Default value |\n| ----------- | ------- | ---------------------------------------------------------------------------------------------------------- | ------------- |\n| timeout | number | Timeout (in ms) between each slide. | undefined |\n| stopOnHover | boolean | Determines whether the autoplay should stop when users are hovering over the slider (true) or not (false). | undefined |\n\n## Advanced configuration\n\nThe `slider-layout-group` block synchronizes the slides rendered by each `slider-layout` block declared in it.\n\nTherefore, the `slider-layout-group` does not render any specific component on the store UI. It is really a logical block that only expects to receive a `children` block list containing the desired `slider-layout` blocks that should be rendered. For example:\n\n`1\n\n{ \n\n2\n\n \"slider-layout-group#test\": { \n\n3\n\n \"children\": [\"slider-layout#1\", \"slider-layout#2\", \"slider-layout#3\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\nBelow, you can find a practical example using three `slider-layout` blocks inside of a `slider-layout-group`. Each `slider-layout` received three `rich-text` blocks as `children` to serve as individual slides:\n\n\n\n> **\\*All `slider-layout` blocks declared in the `slider-layout-group` must have the same configuration, meaning the same props and values**. Due to implementation rules, they can only differ in their `children` block list. Keep in mind that declaring `slider-layout` blocks with different configurations will result in unexpected behavior, leading to errors that are **not** supported by the VTEX Store Framework team.\\*\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the instructions given in the recipe on [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS handles |\n| ----------------------- |\n| paginationDot--isActive |\n| paginationDot |\n| paginationDotsContainer |\n| slide--firstVisible |\n| slide--hidden |\n| slide--lastVisible |\n| slide--visible |\n| slideChildrenContainer |\n| slide |\n| sliderArrows |\n| sliderLayoutContainer |\n| sliderLeftArrow |\n| sliderRightArrow |\n| sliderTrackContainer |\n| sliderTrack |\n\n[Responsive Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.responsive-layout)[Stack LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.stack-layout)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Google Analytics 4 Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.slider-layout%23google-analytics-4-integration)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.slider-layout%23configuration)\n\n[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.slider-layout%23advanced-configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout/docs/apps/vtex.slider-layout%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_83fecb1d
|
[
{
"role": "system",
"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 messages 1.71.0 messages 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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-graphql-api/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-graphql-api/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages)\n\n[Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-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.messages@1.71.0/messages-graphql-api/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-graphql-api/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-graphql-api/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages)\n\n[Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-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.messages@1.71.0/messages-graphql-api/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-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.messages@1.71.0/messages-graphql-api/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/guides/functional-apps)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages)\n\nMessages GraphQL API\n\n[vtex.messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages)\n\nVersion: 1.71.0\n\nLatest version: 1.71.0\n\nThis article serves as a comprehensive reference for the GraphQL API provided by the [Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages). This API enables the internationalization of messages in various store contexts, such as Catalog, Intelligent Search, and VTEX IO apps. For more details about how this API is used, see the [Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app) article.\n\n## Schema overview\n\n### Query\n\nlanguages\n\ntranslations\n\nuserTranslations\n\nlistV2\n\nLanguages\n\nsupported \\[String!\\]!\n\ndefault String!\n\nTranslation\n\nlang String!\n\ntranslation String!\n\nMessageListV2\n\nsrcLang String!\n\ngroupContext String\n\ncontext String\n\ntranslations \\[Translation!\\]!\n\nQuery\n\nlanguages Languages!\n\nauthorize Boolean!\n\ntranslate(args TranslateArgs!) : \\[String\\]!\n\ntranslateWithDependencies(args TranslateWithDependenciesArgs!) : \\[String\\]!\n\nuserTranslations(args IndexedMessages!) : \\[MessageListV2\\]!\n\nlistV2(args ListArgsV2!) : \\[MessageListV2!\\]!\n\n| Field | (argument) | Type | Description |\n| ----------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **languages** | [Languages](#languages)! | Returns the store's default locale and the list of supported languages. These values are defined in the **Default Language** and **Supported Languages** settings in the [Messages app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings). | |\n| **translate** | \\[String\\]! | Endpoint that retrieves a list of translated messages from a specific locale in Catalog. | |\n| args | [TranslateArgs](#translateargs)! | Input for translation requests. | |\n| **translateWithDependencies** | \\[String\\]! | Retrieves a list of translated messages from a specific locale in a VTEX IO app. The response is a list of MessageListV2, where each element contains a list of messages. | |\n| args | [TranslateWithDependenciesArgs](#translatewithdependenciesargs)! | Input for translation requests. Similar to TranslateArgs but requires dependency information. | |\n| **userTranslations** | \\[[MessageListV2](#messagelistv2)\\]! | Retrieves user translations. The response is a list of MessageListV2, where each element contains a list of messages from a specific source (CMS, an app, etc.). | |\n| args | [IndexedMessages](#indexedmessages)! | Group of messages by their source language. | |\n| **listV2** | \\[[MessageListV2](#messagelistv2)!\\]! | Retrieves a subset of all messages stored in VBase. The range argument defines the beginning and the end of the retrieved list. The response is a list of MessageListV2, where each element has a list of messages from a specific source (CMS, an app, etc.). | |\n| args | [ListArgsV2](#listargsv2)! | Argument used for message pagination. | |\n| **authorize** | Boolean! | Handles authorization for requests outside IO using a two-factor [authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens). It works with the **Two Factor URL** [app setting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings). | |\n\n### Mutation\n\nMutation\n\nsaveV2(args SaveArgsV2!) : Boolean!\n\n| Field | (argument) | Type | Description |\n| ---------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **saveV2** | Boolean! | Creates or updates custom messages for the specified locale. This applies to translations for Catalog, Intelligent Search, and installed apps. | |\n| args | [SaveArgsV2](#saveargsv2)! | Input of messages to be saved. | |\n\n## Schema description\n\n> Arguments must be provided by the user. Required fields are marked with an exclamation mark (`!`).\n\n### Languages\n\n| Field | Type | Description |\n| ------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **supported** | \\[String!\\]! | A list of languages the store supports. Each language is defined by its locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. If the request to the Messages app has a target language that isn't supported, it will translate to the default language, which is defined by **Supported Languages** in the [app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings). |\n| **default** | String! | The default fallback language for the store, defined by its locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. If the value is \\*, all languages will be supported. This is defined by **Default Language** in the [app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings). |\n\n[Query](#query) 🔼\n\n### MessageListV2\n\n| Field | Type | Description |\n| ---------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **srcLang** | String! | Locale code of the message list source content in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. |\n| **groupContext** | String | Groups related translations based on their context.Apps: automaticV2.CMS: CMS.Undefined: null. |\n| **context** | String | Defines the context for the translation. For example:Catalog: ID of the product/brand/category you want to translate, found in the Admin under **Product** \\> **Catalog**.Apps: The name of the app in which the message is being overwritten.Intelligent Search: intelligentSearchFacets, which defines the context of VTEX Intelligent Search. |\n| **translations** | \\[[Translation](#translation)!\\]! | List of messages in the context. |\n\n[Query](#query) 🔼\n\n[IndexedMessages](#indexedmessages) 🔽\n\n### Translation\n\n| Field | Type | Description |\n| --------------- | ------- | ---------------------------------------------------------------------------------------------------------------------- |\n| **lang** | String! | Message locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. |\n| **translation** | String! | The translated message string. |\n\n[MessageListV2](#messagelistv2) 🔼\n\n### IndexedMessages\n\n| Field | Type | Description |\n| ------------ | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | Source message locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. |\n| **messages** | \\[[MessageInputV2](#messageinputv2)!\\]! | List of messages to check translations. Each item in the list is a message in MessageInputV2 format. |\n\n[Query](#query) 🔼\n\n[TranslateArgs](#translateargs) 🔽\n\n[TranslateWithDependenciesArgs](#translatewithdependenciesargs) 🔽\n\n### ListArgsV2\n\n| Field | Type | Description |\n| --------- | -------------------------------- | --------------------------------------------------------- |\n| **range** | [MessagesRange](#messagesrange)! | Range indicating the first and last messages in the list. |\n\n[Query](#query) 🔼\n\n### MessageInputV2\n\n| Field | Type | Description |\n| ------------ | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **content** | String! | Source message string. |\n| **context** | String | Provides context for the message. For example:Catalog: ID of the product/brand/category you want to check the translation, found in the Admin under Product > Catalog.Apps: The name of the app in which the message has been overwritten. |\n| **behavior** | [Behavior](#behavior) | Defines the translation source. The available options are USER\\_ONLY, USER\\_AND\\_APP, and FULL. |\n\n[IndexedMessages](#indexedmessages) 🔼\n\n### MessageSaveInputV2\n\n| Field | Type | Description |\n| ----------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **srcLang** | String! | Store's locale default code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. In the VTEX Intelligent Search context, this variable must be the store's binding default. |\n| **srcMessage** | String! | The source message based on its context:Catalog: Source message string.Apps: The ID of your message string declared in the app's messages folder.Intelligent Search: Source message string. Check the list below for the possible values of this variable and their definitions.Category 1: Department.Category 2: Category.Category 3: Subcategory.Price: Price.Promotion: Promotion.New Release: New release.Location: Location.Brand: Brand. |\n| **targetMessage** | String! | Catalog: Translated message string.Apps: Translated message string.Intelligent Search: Translated message string. |\n| **groupContext** | String | Groups related translations based on their context.Apps: automaticV2.CMS: CMS.Undefined: null. |\n| **context** | String | Catalog: ID of the product/brand/category you want to translate, found in the Admin under **Product** \\> **Catalog**.Apps: The name of the app in which the message is being overwritten.Intelligent Search: intelligentSearchFacets, which defines the context of VTEX Intelligent Search. |\n\n[SaveArgsV2](#saveargsv2) 🔽\n\n### MessagesRange\n\n| Field | Type | Description |\n| -------- | ---- | ----------------------------------- |\n| **from** | Int! | Position of the first list element. |\n| **to** | Int! | Position of the last list element. |\n\n[ListArgsV2](#listargsv2) 🔼\n\n### SaveArgsV2\n\n| Field | Type | Description |\n| ------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| **to** | String! | Target locale code ([ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php), for example: en-US) for the translation. |\n| **messages** | \\[[MessageSaveInputV2](#messagesaveinputv2)!\\]! | List of messages to be translated. |\n| **fireEvent** | Boolean | If true, the request triggers an event. Default: false. |\n\n[Mutation](#mutation) 🔼\n\n### TranslateArgs\n\n| Field | Type | Description |\n| ----------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **indexedByFrom** | \\[[IndexedMessages](#indexedmessages)!\\]! | List of IndexedMessages. Each item in the list has a locale and a corresponding list of messages. |\n| **to** | String! | Target locale code ([ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php), for example: en-US) for the translation. |\n| **depTree** | String | The dependency tree in the format \"\\[{\"id\": \"{context}\"}\\]\". Example: \"\\[{\"id\": \"[vtex.store-components@3.x](mailto:vtex.store-components@3.x)\"}\\]\". |\n| **encoding** | [Encoding](#encoding) | The encoding format for messages sent to the automatic translation service. The available formats are ICU and HANDLEBARS. |\n\n[Query](#query) 🔼\n\n### TranslateWithDependenciesArgs\n\n| Field | Type | Description |\n| ----------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **indexedByFrom** | \\[[IndexedMessages](#indexedmessages)!\\]! | List of IndexedMessages. Each item in the list has a locale and a corresponding list of messages. |\n| **to** | String! | Target locale code ([ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php), for example: en-US) for the translation. |\n| **depTree** | String! | The dependency tree in the format \"\\[{\"id\": \"{context}\"}\\]\". Example: \"\\[{\"id\": \"[vtex.store-components@3.x](mailto:vtex.store-components@3.x)\"}\\]\". |\n| **encoding** | [Encoding](#encoding) | The encoding format for messages sent to the automatic translation service. The available formats are ICU and HANDLEBARS. |\n\n[Query](#query) 🔼\n\n### Behavior\n\n| Value | Description |\n| ------------------ | ---------------------------------------------------------------------------------------- |\n| **USER\\_ONLY** | Only uses translations defined by users, ignoring app and automatic translations. |\n| **USER\\_AND\\_APP** | Uses both user-defined and app-defined translations, but ignores automatic translations. |\n| **FULL** | Uses all available translation sources. |\n\n[MessageInputV2](#messageinputv2) 🔼\n\n### Encoding\n\n| Value | Description |\n| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **ICU** | Use for messages to be encoded in [ICU (International Components for Unicode) format](https://read.calvincode.net/reader?url=https://unicode-org.github.io/icu/userguide/format%5Fparse/messages) through the [ICU MessageFormat Parser](https://read.calvincode.net/reader?url=https://formatjs.github.io/docs/icu-messageformat-parser). |\n| **HANDLEBARS** | Use for messages to be encoded in [Handlebars format](https://read.calvincode.net/reader?url=https://handlebarsjs.com/guide/%23installation). |\n\n[TranslateArgs](#translateargs) 🔼\n\n[TranslateWithDependenciesArgs](#translatewithdependenciesargs) 🔼\n\n[Messages« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages)[Product ContextNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.product-context)\n\nSee also\n\n[Vtex.messagesVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages)[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.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23schema-description)\n\n[Languages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23languages)[MessageListV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23messagelistv2)[Translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23translation)[IndexedMessages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23indexedmessages)[ListArgsV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23listargsv2)[MessageInputV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23messageinputv2)[MessageSaveInputV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23messagesaveinputv2)[MessagesRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23messagesrange)[SaveArgsV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23saveargsv2)[TranslateArgs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23translateargs)[TranslateWithDependenciesArgs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23translatewithdependenciesargs)[Behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23behavior)[Encoding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages@1.71.0/messages-graphql-api/docs/apps/vtex.messages@1.71.0/messages-graphql-api%23encoding)\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_34b6bc07
|
[
{
"role": "system",
"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 BackToTopButton 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/BackToTopButton/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/BackToTopButton/docs/api-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/BackToTopButton/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/BackToTopButton/docs/storefront-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/BackToTopButton/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/BackToTopButton/docs/troubleshooting)\n\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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/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/BackToTopButton/docs/vtex-io-apps)\n\nBack To Top Button\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\nThe `back-to-top-button` component is a button that redirects users to the top of the page when clicked.\n\n\n\n_Back To Top Button rendered as a text button_\n\n\n\n_Back To Top Button rendered as a caret icon_\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 `back-to-top-button` block into a store template of your choice. In the example, it will be added to the home page:\n\n`1\n\n \"store.home\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n+ \"back-to-top-button\", \n\n4\n\n ] \n\n5\n\n }, \n\n`\n\n1. Then, declare the `back-to-top-button` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"store.home\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"back-to-top-button\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n+ \"back-to-top-button\":{ \n\n7\n\n+ \"props\":{ \n\n8\n\n+ \"displayThreshold\": 800, \n\n9\n\n+ } \n\n10\n\n+ } \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default Value |\n| ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| display | enum | Defines the component rendering. Possible values are: button to display a button with a Back To Top label text or caret-icon to display just an icon. | button |\n| displayThreshold | number | Defines the window Y pixel in which the button will be displayed. | 600 |\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| backToTopButtonActive |\n| backToTopButtonContainer |\n| backToTopButtonHidden |\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/BackToTopButton/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/BackToTopButton/docs/apps/vtex.store-components@3.178.5/BackToTopButton%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BackToTopButton/docs/apps/vtex.store-components@3.178.5/BackToTopButton%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BackToTopButton/docs/apps/vtex.store-components@3.178.5/BackToTopButton%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_03c91c78
|
[
{
"role": "system",
"content": "You are a VTEX 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 service configuration apps in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/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/vtex-io-documentation-developing-service-configuration-apps/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/vtex-io-documentation-developing-service-configuration-apps/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/vtex-io-documentation-developing-service-configuration-apps/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/vtex-io-documentation-developing-service-configuration-apps/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/vtex-io-documentation-developing-service-configuration-apps/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/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-service-configuration-apps/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/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/vtex-io-documentation-developing-service-configuration-apps/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/vtex-io-documentation-developing-service-configuration-apps/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/vtex-io-documentation-developing-service-configuration-apps/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/vtex-io-documentation-developing-service-configuration-apps/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/vtex-io-documentation-developing-service-configuration-apps/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/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-service-configuration-apps/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/app-development-guides)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\nDeveloping service configuration apps\n\nLearn how to create standalone apps dedicated to configuring services within the VTEX IO platform.\n\nThis guide will walk you through the process of creating standalone apps dedicated to configuring services within the VTEX IO platform. By following these steps, you can enhance the adaptability and versioning of your VTEX IO apps.\n\nTo complete this guide, we will develop apps with two distinct purposes:\n\n* **Service apps:** These applications provide specific functionalities to other apps or users within the VTEX platform. They are what other apps configure to leverage particular features or services. Service apps are developed using either the `node`, `dotnet`, or `graphql` builder.\n* **Configuration apps:** These independent applications are designed to configure Service apps. Their primary role is to define how a service app should behave, specifying settings and adapting its functionality to meet the needs of other apps or users. Configuration apps use the `configuration` builder, which separates service configuration code into an independent app, decoupled from the platform.\n\nIn the diagram below, you can see how Service and Configuration apps interact with each other. Service apps expose their schema configurations via the `schema.json` file, and Configuration apps utilize this information to manage and deliver configurations via the `configuration.json` file. This separation of concerns enhances organization and modularity in application development, especially in the context of configuration management.\n\nProvides schema configurations\n\nConfiguration app\n\nService builder\n\nconfiguration.json\n\nService app\n\nconfiguration\n\nschema.json\n\nnode\n\n## Instructions\n\n### Step 1 - Creating a Service app\n\nIn this initial stage, you will create a Service app to house the service configurations for another VTEX IO app.\n\n1. Open the terminal and use 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/) to log in to your VTEX account. \n`1 \nvtex login {accountName} \n`\n2. Start a new VTEX IO app project by running the following command. \n`1 \nvtex init \n`\n3. Select the `service-example` option.\n4. Open the app project in your preferred code editor.\n\n### Step 2 - Configuring the Service App\n\nNow, declare that your app can receive configurations through requests. Follow the instructions below based on your scenario:\n\nNode service\n\nIn the `node/service.json` file, add `\"settingsType\": \"workspace\"` to define which routes will be able to receive configurations through requests. For example:\n\n`1\n\n\"routes\": { \n\n2\n\n \"status\": { \n\n3\n\n \"path\": \"/_v/status/:code\", \n\n4\n\n \"public\": true, \n\n5\n\n \"settingsType\": \"workspace\" \n\n6\n\n }, \n\n7\n\n} \n\n`\n\nIt is also possible to define your configurations through event listening. In this case, you should add to the `node/service.json` file something similar to the example below, replacing the values according to your needs:\n\n`1\n\n\"events\": { \n\n2\n\n \"eventHandler\": { \n\n3\n\n \"sender\": \"appEmittingTheEvent\", \n\n4\n\n \"keys\": [\"topic\"], \n\n5\n\n \"settingsType\": \"workspace\" \n\n6\n\n }, \n\n7\n\n} \n\n`\n\nGraphQL app\n\nIf you are developing a GraphQL app, add the `@settings` directive to all queries that can receive configurations.\n\nA [GraphQL Directive](https://read.calvincode.net/reader?url=https://graphql.org/learn/queries/%23directives) is a way of changing how the query will be performed. When you add the `settings` directive, the system knows it must search for configurations for that service. Under the hood, this directive includes an additional step in the query, which is responsible for finding all configurations and adding them to the context.\n\nTake the [graphql-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/graphql-example) app as an example. In this app's root directory, you'll see the following file `graphql/schema.graphql`. Now, if you open it and add the `@settings` directive to the query `book`, you'll have something like:\n\n`1\n\n type Query { \n\n2\n\n- book(id: ID!): Book \n\n3\n\n+ book(id: ID!): Book @settings(settingsType: \"workspace\") \n\n4\n\n } \n\n5\n\n \n6\n\n+ @settings(settingsType: \"workspace\") \n\n`\n\n### Step 3 - Declaring policies and permissions\n\nIn the `manifest.json` file, add the `read-workspace-apps` [policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies) to the `policies` list. This policy allows the service app to read data from the configuration app.\n\n`1\n\n\"policies\": [ \n\n2\n\n { \n\n3\n\n \"name\": \"read-workspace-apps\" \n\n4\n\n } \n\n5\n\n] \n\n`\n\n### Step 4 - Setting up the `configuration` builder\n\n1. Open the app's `manifest.json` file and add the `configuration` builder to the `builders` list. Also, update the `name` and `vendor` fields according to your scenario. For example: \n`1 \n { \n2 \n \"name\": \"vtex.most-amazing-service-ever\", \n3 \n \"version\": \"0.0.0\", \n4 \n \"builders\": { \n5 \n \"node\": \"7.x\", \n6 \n+ \"configuration\": \"0.x\" \n7 \n } \n8 \n } \n`\n2. Create a `configuration` folder in your app's root directory.\n3. Create a file named `schema.json` inside the `configuration` folder. This file holds information about the settings structure that the Service app will accept from other apps on the platform.\n4. In the `configuration/schema.json` file, create a JSON Schema according to your scenario. The JSON Schema will be used to identify new configurations coming from apps and define the expected format of a new configuration. For example: \n`1 \n{ \n2 \n \"type\": \"object\", \n3 \n \"properties\": { \n4 \n \"id\": { \"type\": \"number\" }, \n5 \n \"name\": { \"type\": \"string\" } \n6 \n } \n7 \n} \n` \nIn the example above, the accepted configuration is an object with two keys: `id` and `name`, where the first is a number, and the second is a string.\n\n### Step 5 - Deploying the Service app\n\nSave your changes and then [deploy your new Service app](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 6 - Linking the Configuration app to the Service app\n\nOnce your Service app is deployed, it is ready to receive configurations from other apps.\n\n1. Start a new Configuration app project.\n2. Add the recently created Service app as a new builder to the `manifest.json` file of your new Configuration app. For example: \n`1 \n{ \n2 \n \"name\": \"vtex.amazing-configuration\", \n3 \n \"version\": \"0.0.0\", \n4 \n \"builders\": { \n5 \n+ \"vtex.most-amazing-service-ever\": \"0.x\", \n6 \n } \n7 \n} \n`\n\nEnsure that the builder's name matches the Service you want your app to configure and that its version matches the desired Service app version.\n\n1. Create a new folder named after your Service app and create a new file named `configuration.json` within it (e.g., `vtex.most-amazing-service-ever/configuration.json`).\n2. In the `configuration.json`, define the expected service configurations according to the JSON schema structure previously defined in the Service app. For example: \n`1 \n{ \n2 \n \"name\": \"little foot\", \n3 \n \"id\": 19 \n4 \n} \n`\n3. Save your changes and then [publish your new Configuration app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/).\n\n## Reading the received Service app configurations\n\nUnderstanding how to access configurations received by the Service app is crucial. As mentioned earlier, these configurations originate from other apps within the context of their respective requests.\n\nTo retrieve the configurations received by the Service app, use the following command:\n\n`1\n\nconst settings = ctx.vtex.settings; \n\n`\n\nThe `ctx` can be either `EventContext` or `ServiceContext`.\n\nThe received configurations are structured as an array of objects, as demonstrated in the example below:\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"vtex.amazing-configuration\": { \n\n4\n\n \"name\": \"little foot\", \n\n5\n\n \"id\": 1 \n\n6\n\n }, \n\n7\n\n \"declarer\": \"vtex.amazing-configuration@0.0.0+build1580823094\" \n\n8\n\n } \n\n9\n\n] \n\n`\n\nEach element in this array consists of:\n\n* An object containing the `name` of the app that configures the service (e.g., `vtex.amazing-configuration`) and the configuration schema's settings, adhering to the structure defined in the Service app's `schema.json` file.\n* The `declarer` key, which holds the full name of the app responsible for these configurations.\n\nNote that multiple apps can configure the same service. Hence, each element in this array represents a configuration originating from a different app.\n\n> If you are getting errors with the service configuration app, see the [troubleshooting guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-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/guides/vtex-io/Getting-Started/back-end-development-guides/vtex-io-documentation-developing-service-configuration-apps.md)\n\n[Configuring dynamic routes in VTEX IO services« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps//docs/guides/configuring-dynamic-routes-in-vtex-io-services)[Node builder 7.x migration guideNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps//docs/guides/node-builder-7x-migration-guide)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23instructions)\n\n[Step 1 - Creating a Service app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-1-creating-a-service-app)[Step 2 - Configuring the Service App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-2-configuring-the-service-app)[Step 3 - Declaring policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-3-declaring-policies-and-permissions)[Step 4 - Setting up the configuration builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-4-setting-up-the-configuration-builder)[Step 5 - Deploying the Service app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-5-deploying-the-service-app)[Step 6 - Linking the Configuration app to the Service app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-6-linking-the-configuration-app-to-the-service-app)\n\n[Reading the received Service app configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23reading-the-received-service-app-configurations)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/back-end-development-guides/vtex-io-documentation-developing-service-configuration-apps.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-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23instructions)\n\n[Step 1 - Creating a Service app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-1-creating-a-service-app)[Step 2 - Configuring the Service App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-2-configuring-the-service-app)[Step 3 - Declaring policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-3-declaring-policies-and-permissions)[Step 4 - Setting up the configuration builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-4-setting-up-the-configuration-builder)[Step 5 - Deploying the Service app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-5-deploying-the-service-app)[Step 6 - Linking the Configuration app to the Service app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23step-6-linking-the-configuration-app-to-the-service-app)\n\n[Reading the received Service app configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps/docs/guides/vtex-io-documentation-developing-service-configuration-apps%23reading-the-received-service-app-configurations)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_7a674ced
|
[
{
"role": "system",
"content": "You are a VTEX 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 productsummaryskuselector in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-productsummaryskuselector/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-productsummaryskuselector/docs/api-reference)\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-productsummaryskuselector/docs/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-productsummaryskuselector/docs/storefront-development)\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-productsummaryskuselector/docs/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-productsummaryskuselector/docs/troubleshooting)\n\n[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-productsummaryskuselector/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/updates/release-notes)\n\nProduct Summary SKU Selector\n\nThe `product-summary-sku-selector` is a VTEX block that's tasked with rendering the [SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector) component in a Product Summary component, such as the Shelf or the Search Results Page.\n\n\n\n## Configuration\n\n1. Follow the [Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary) app's configuration instruction.\n2. Add the `product-summary-sku-selector` to the Product Summary's desired block. In the following example, we'll use a Shelf:\n\n`1\n\n\"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-add-to-list-button\", \n\n4\n\n \"stack-layout#prodsum\", \n\n5\n\n \"product-summary-name\", \n\n6\n\n \"product-rating-inline\", \n\n7\n\n \"product-summary-space\", \n\n8\n\n \"product-summary-sku-selector\", \n\n9\n\n \"product-summary-price\", \n\n10\n\n \"product-identifier.summary\", \n\n11\n\n \"product-summary-buy-button\" \n\n12\n\n ] \n\n13\n\n }, \n\n`\n\n1. Below, declare the `product-summary-sku-selector` block. The props that it uses are the same that are available for the [SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector). For example:\n\n`1\n\n \"product-summary-sku-selector\": { \n\n2\n\n \"props\":{ \n\n3\n\n \"showVariationsLabels\": [\"false\"] \n\n4\n\n } \n\n5\n\n}, \n\n`\n\n> The Product Summary SKU block can only be modified through the source code. It's not possible yet to edit it via the Site Editor.\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| SKUSelectorContainer |\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-product-summary-productsummaryskuselector.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/docs/guides/vtex-product-summary-productsummaryskuselector%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/docs/guides/vtex-product-summary-productsummaryskuselector%23customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-product-summary-productsummaryskuselector.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/docs/guides/vtex-product-summary-productsummaryskuselector%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector/docs/guides/vtex-product-summary-productsummaryskuselector%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_b972593e
|
[
{
"role": "system",
"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 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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/Share/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/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/Share/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Share/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/Share/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/Share/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/Share/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/Share/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/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@3.178.5/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@3.178.5/Share/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/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/Share/docs/vtex-io-apps)\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\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/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@3.178.5/Share/docs/apps/vtex.store-components@3.178.5/Share%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Share/docs/apps/vtex.store-components@3.178.5/Share%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Share/docs/apps/vtex.store-components@3.178.5/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_40184e68
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides allow manual prices on vtex sales app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app)\n\n[Change VTEX Sales App language](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/change-vtex-sales-app-language)\n\n[Hide anonymous customer option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/hide-anonymous-customer-option)\n\n[Define payment methods displayed on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n\n[Enable the Observation field in the order screen](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/enable-the-remarks-field-in-the-order-screen)\n\n[Enable the sales associate code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/sales-associate-code)\n\n[Enable cart transfer and capture between devices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/force-stock-availability)\n\n[Add extra text to the order summary print](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/add-extra-text-to-the-order-print)\n\n[Hide Print order and Reprint receipt buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/hide-print-order-and-reprint-receipt-buttons)\n\n[Enable partial cancellation for Debit or Credit Direct sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/hide-cancellation-buttons)\n\n[Allow manual prices on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app)\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/integration-vtex-sales-app-local-stock-sale)\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app)\n\n[Change VTEX Sales App language](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/change-vtex-sales-app-language)\n\n[Hide anonymous customer option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/hide-anonymous-customer-option)\n\n[Define payment methods displayed on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n\n[Enable the Observation field in the order screen](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/enable-the-remarks-field-in-the-order-screen)\n\n[Enable the sales associate code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/sales-associate-code)\n\n[Enable cart transfer and capture between devices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/force-stock-availability)\n\n[Add extra text to the order summary print](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/add-extra-text-to-the-order-print)\n\n[Hide Print order and Reprint receipt buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/hide-print-order-and-reprint-receipt-buttons)\n\n[Enable partial cancellation for Debit or Credit Direct sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/hide-cancellation-buttons)\n\n[Allow manual prices on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app)\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/integration-vtex-sales-app-local-stock-sale)\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides)\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app)\n\n[Allow manual prices on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app)\n\nAllow manual prices on VTEX Sales App\n\nThe manual prices feature allows VTEX Sales App sales associates to change prices directly on the product page on inStore and in the shopping cart on the ecommerce website.\n\n## Configuration\n\nTo make this feature available to sales associates using VTEX Sales App, it is necessary to enable it using the Checkout API. You must place a request to the [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updateorderformconfiguration) endpoint, setting the `allowManualPrice` property to `true`.\n\n> This configuration also changes the behavior of the ecommerce, allowing any user with a role that contains the **Telesales** resource to insert manual prices in the ecommerce shopping cart, as described in the [Telesales features](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/telesales-features--UqhiccIRIK2KD0OqkzJaS%23manual-pricing) article on VTEX Help Center.\n\nSince VTEX Sales App sales associates are automatically created with the VTEX Sales App Salesperson role, as explained in [Managing physical stores and sales reps on VTEX Sales App](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-sales-app-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc/5PSjRstg7UU4lOm0s8aqKN), they already have the **Telesales** resource associated with their account. This means that once the configuration is enabled on the Checkout API, they will automatically be able to edit prices on VTEX Sales App or in the ecommerce shopping cart.\n\n## Usage\n\nAfter enabling manual prices, to change a product price on VTEX Sales App, sales associates can follow the steps below.\n\n1. On VTEX Sales App, search for any product using the search bar.\n2. Click on `More details`.\n3. Click on the desired variation of the product.\n4. Click on `Change`, an option that will appear next to the product price. When you click this component, you will see a modal that allows you to set a new price, as shown below. \n\n5. Enter a new value to change the product price. There are no restrictions to increase or reduce prices.\n6. Click on `Change price` to confirm. The altered price will be applied only on this purchase.\n\nAfter that, they can proceed with the remaining steps to place the order.\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/allow-manual-prices-on-vtex-sales-app.md)\n\n[Hide cancellation buttons« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app//docs/guides/hide-cancellation-buttons)[Integration VTEX Sales App Local stock saleNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app//docs/guides/integration-vtex-sales-app-local-stock-sale)\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app%23configuration)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app%23usage)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Sales-App/how-to-customize-vtex-sales-app/allow-manual-prices-on-vtex-sales-app.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/allow-manual-prices-on-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app%23configuration)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app%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_1c97cf2b
|
[
{
"role": "system",
"content": "You are a VTEX 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 admin builder in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-manifest)\n\n[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-billing-options)\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-builders)\n\n[Admin Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder)\n\n[Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-assets-builder)\n\n[Docs Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-docs-builder)\n\n[GraphQL Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-graphql-builder)\n\n[Messages Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-messages-builder)\n\n[Node Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-node-builder)\n\n[PaymentProvider Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-paymentprovider-builder)\n\n[Pixel Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-pixel-builder)\n\n[React Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-react-builder)\n\n[Store Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-store-builder)\n\n[Styles Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-styles-builder)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-dependencies)\n\n[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-peerdependencies)\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-manifest)\n\n[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-billing-options)\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-builders)\n\n[Admin Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder)\n\n[Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-assets-builder)\n\n[Docs Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-docs-builder)\n\n[GraphQL Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-graphql-builder)\n\n[Messages Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-messages-builder)\n\n[Node Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-node-builder)\n\n[PaymentProvider Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-paymentprovider-builder)\n\n[Pixel Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-pixel-builder)\n\n[React Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-react-builder)\n\n[Store Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-store-builder)\n\n[Styles Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-styles-builder)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-dependencies)\n\n[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-peerdependencies)\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/app-development)\n\nProject structure\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-builders)\n\n[Admin Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder)\n\nAdmin builder\n\nLearn how to use the VTEX IO Admin builder.\n\nThe `admin` builder is used to develop apps for the [VTEX Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-admin-start-here--531cHtUCUi3puRXNDmKziw) in combination with [React](https://read.calvincode.net/reader?url=https://react.dev). To understand better how to develop apps using this builder, access our [Admin Applications course](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-admin-lang-en).\n\n## Folder structure\n\nAn app that uses the `admin` builder has an `admin` folder on its root, where are located the following files and directories:\n\n`1\n\nadmin \n\n2\n\n ┣ 📄 navigation.json \n\n3\n\n ┗ 📄 routes.json \n\n`\n\n* `navigation.json`: Defines the navigation in the Admin left panel for sections and pages. The file structure consists of an object or list of objects for each section, with a list of objects for the subsections (`\"subSectionItens\"` field).\n* `routes.json`: Assigns the components to their corresponding routes (`\"path\"` field). The file structure consists of an object of objects, where each object defines a component with its route. The routes have to match the paths described in the `navigation.json` file. The names of the components (`\"component\"` field) have to match the React components in the `react` folder.\n\n## Usage\n\nTo develop an app using the `admin` builder, refer to the following steps:\n\n1. **Start with a template**: Download the [admin-ui-example template](https://read.calvincode.net/reader?url=https://github.com/vtex/admin-ui-example/tree/main) or create a new project using the [vtex init CLI command](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-usage%23starting-a-new-project) and choose the `admin-example` option.\n2. **Configure the navigation**: Edit the `navigation.json` file to define the structure of the sections and pages of the app in the Admin's left panel.\n3. **Configure the routes**: Edit the `routes.json` file to define the components and associate them with the navigation.\n4. **Implement the app's logic**: Add your frontend logic using React. Check the [Admin Applications course](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-admin-lang-en) for more details.\n5. **Testing**: [Link the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) to a development workspace for testing.\n\n## Use case examples\n\nHere are some app examples that use the `admin` builder:\n\n* [checkout-ui-custom](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/checkout-ui-custom)\n* [storefront-permissions-ui](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/storefront-permissions-ui)\n* [admin-graphql-ide](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/admin-graphql-ide)\n\nAs an example, check the file contents for this builder in the [Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom):\n\n### `navigation.json` file\n\nIn this example, there is a list of objects. It is also possible to have only a single object.\n\nnavigation.json\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"section\": \"storeSetup\", \n\n4\n\n \"titleId\": \"admin/checkout-ui.navigation.title\", \n\n5\n\n \"path\": \"/admin/vtex-checkout-ui-custom/\", \n\n6\n\n \"LMProductId\": \"27\" \n\n7\n\n }, \n\n8\n\n { \n\n9\n\n \"section\": \"storeSettings\", \n\n10\n\n \"subSection\": \"storeFront\", \n\n11\n\n \"adminVersion\": 4, \n\n12\n\n \"LMProductId\": \"27\", \n\n13\n\n \"subSectionItems\": [ \n\n14\n\n { \n\n15\n\n \"labelId\": \"admin/checkout-ui.navigation.title\", \n\n16\n\n \"path\": \"/admin/vtex-checkout-ui-custom/\" \n\n17\n\n } \n\n18\n\n ] \n\n19\n\n } \n\n20\n\n] \n\n`\n\nThe properties in these objects are:\n\n* `\"adminVersion\"`: Specifies the Admin version for the page. The presence of this property only in the second object indicates that the first one is for the Admin version `3.x` and the second one is for the [redesigned Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/v4).\n* `\"section\"` and `\"subSection\"`: indicate which section and subsection of the Admin the page will be, respectively. The first will be inside an existing section, `\"storeSetup\"`. The second object will be inside an existing section, `\"storeSettings\"`, and an existing subsection, `\"storeFront\"`.\n* `\"path\"`: Contains the path in the URL to access the page, and correlates with the component defined in the `routes.json` file.\n* `\"subSectionItems\"`: A list where each object represents a page in the subsection.\n* `\"titleId\"` and `\"labelId\"`: Identifiers of the component. This will be used by the `messages` builder to map the navigation and the name of the app in each language.\n\n### `routes.json` file\n\nHere we have an object of objects, where each inner object maps a component to a path. The keys of the objects inside use the format `\"admin.app.{routeName}\"`, where `{routeName}` is an identifier to the route.\n\nroutes.json\n\n`1\n\n{ \n\n2\n\n \"admin.app.checkout-ui\": { \n\n3\n\n \"component\": \"Admin\", \n\n4\n\n \"path\": \"/admin/app/vtex-checkout-ui-custom\" \n\n5\n\n } \n\n6\n\n} \n\n`\n\nThe properties of the inner object are:\n\n* `\"component\"`: Name of the React component corresponding to the page in the route.\n* `\"path\"`: Contains the path in the URL to access the page, and correlates with the component defined in the `navigation.json` file. Note that the path here only differs from the one in the `navigation.json` file by having a `/app` segment.\n\n### Result\n\nAs we can see in the image of the app running in the Admin, the path in the address bar (`/admin/vtex-checkout-ui-custom/`) is the same as the one in the path property from the `navigation.json` file. In the Admin left navigation bar, we can see that the **Checkout UI Custom** app is inside the **Store Settings** section and the **STOREFRONT** subsection, as described by the `\"section\"` and `\"subSection\"` properties.\n\n\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-builders/vtex-io-documentation-admin-builder.md)\n\n[Builders« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder//docs/guides/vtex-io-documentation-builders)[Assets BuilderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder//docs/guides/vtex-io-documentation-assets-builder)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23use-case-examples)\n\n[navigation.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23navigationjson-file)[routes.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23routesjson-file)[Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23result)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-builders/vtex-io-documentation-admin-builder.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23use-case-examples)\n\n[navigation.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23navigationjson-file)[routes.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23routesjson-file)[Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-admin-builder/docs/guides/vtex-io-documentation-admin-builder%23result)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_75c7e97c
|
[
{
"role": "system",
"content": "You are a VTEX 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 inventory 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-inventory-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-inventory-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-inventory-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-inventory-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-inventory-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-inventory-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-inventory-information/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-information/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-information/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-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-inventory-information/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-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-inventory-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-inventory-information/docs/guides/synchronizing-product-information)\n\n[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-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-inventory-information/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-information/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-information/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-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-inventory-information/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-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-inventory-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-inventory-information/docs/guides/synchronizing-product-information)\n\n[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-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-inventory-information/docs/guides)\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-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-inventory-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-inventory-information/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information)\n\nSynchronizing inventory information\n\nEnsure inventory availability data is kept up to date for ad display.\n\nInventory information defines the price, promotional price, and \"stock.\" Regarding stock, we should only receive whether the product is available for sale.\n\nLearn more about each field on `POST` [Synchronize inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/product/bulk/inventories).\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/inventories 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\": \"120210\", \n\n10\n\n \"store_id\": \"1\", \n\n11\n\n \"price\": 18.20, \n\n12\n\n \"promotional_price\": 16.32, \n\n13\n\n \"is_available\": true \n\n14\n\n }, \n\n15\n\n { \n\n16\n\n \"product_sku\": \"120212\", \n\n17\n\n \"price\": 18.20, \n\n18\n\n \"promotional_price\": 0, // this removes the promotional price \n\n19\n\n \"is_available\": true \n\n20\n\n } \n\n21\n\n] \n\n`\n\n### Response with validation error\n\nFor validations, we use the [RFC 8927](https://read.calvincode.net/reader?url=https://datatracker.ietf.org/doc/rfc8927/) format, 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\": { \n\n7\n\n \"missingProperty\": \"product_sku\" \n\n8\n\n }, \n\n9\n\n \"message\": \"must have required property 'product_sku'\" \n\n10\n\n }, \n\n11\n\n { \n\n12\n\n \"instancePath\": \"/0\", \n\n13\n\n \"schemaPath\": \"#/items/required\", \n\n14\n\n \"keyword\": \"required\", \n\n15\n\n \"params\": { \n\n16\n\n \"missingProperty\": \"promotional_price\" \n\n17\n\n }, \n\n18\n\n \"message\": \"must have required property 'promotional_price'\" \n\n19\n\n }, { \n\n20\n\n \"instancePath\": \"/0\", \n\n21\n\n \"schemaPath\": \"#/items/required\", \n\n22\n\n \"keyword\": \"required\", \n\n23\n\n \"params\": { \n\n24\n\n \"missingProperty\": \"is_available\" \n\n25\n\n }, \n\n26\n\n \"message\": \"must have required property 'is_available'\" \n\n27\n\n }, \n\n28\n\n { \n\n29\n\n \"instancePath\": \"/1\", \n\n30\n\n \"schemaPath\": \"#/items/required\", \n\n31\n\n \"keyword\": \"required\", \n\n32\n\n \"params\": { \n\n33\n\n \"missingProperty\": \"price\" \n\n34\n\n }, \n\n35\n\n \"message\": \"must have required property 'price'\" \n\n36\n\n }, { \n\n37\n\n \"instancePath\": \"/1\", \n\n38\n\n \"schemaPath\": \"#/items/required\", \n\n39\n\n \"keyword\": \"required\", \n\n40\n\n \"params\": { \n\n41\n\n \"missingProperty\": \"promotional_price\" \n\n42\n\n }, \n\n43\n\n \"message\": \"must have required property 'promotional_price'\" \n\n44\n\n }, \n\n45\n\n { \n\n46\n\n \"instancePath\": \"/1\", \n\n47\n\n \"schemaPath\": \"#/items/required\", \n\n48\n\n \"keyword\": \"required\", \n\n49\n\n \"params\": { \n\n50\n\n \"missingProperty\": \"is_available\" \n\n51\n\n }, \n\n52\n\n \"message\": \"must have required property 'is_available'\" \n\n53\n\n }, { \n\n54\n\n \"instancePath\": \"/2\", \n\n55\n\n \"schemaPath\": \"#/items/required\", \n\n56\n\n \"keyword\": \"required\", \n\n57\n\n \"params\": { \n\n58\n\n \"missingProperty\": \"price\" \n\n59\n\n }, \n\n60\n\n \"message\": \"must have required property 'price'\" \n\n61\n\n }, \n\n62\n\n { \n\n63\n\n \"instancePath\": \"/2\", \n\n64\n\n \"schemaPath\": \"#/items/required\", \n\n65\n\n \"keyword\": \"required\", \n\n66\n\n \"params\": { \n\n67\n\n \"missingProperty\": \"is_available\" \n\n68\n\n }, \n\n69\n\n \"message\": \"must have required property 'is_available'\" \n\n70\n\n } \n\n71\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-inventory-information.md)\n\n[Synchronizing product information« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information//docs/guides/synchronizing-product-information)[Retrieving adsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information//docs/guides/retrieving-ads)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information%23request)\n\n[Response with validation error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-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-inventory-information.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-information%23request)\n\n[Response with validation error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information/docs/guides/synchronizing-inventory-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_97a743b8
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation migrating storefront from legacy to 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-migrating-storefront-from-legacy-to-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-migrating-storefront-from-legacy-to-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-migrating-storefront-from-legacy-to-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-migrating-storefront-from-legacy-to-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-migrating-storefront-from-legacy-to-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-migrating-storefront-from-legacy-to-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-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)\n\n[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/can-i-order-my-product-as-i-want)\n\n[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/list-of-controls-for-templates)\n\n[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/creating-gift-lists)\n\n[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/validating-a-layout-before-moving-it-to-production)\n\n[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/how-to-use-the-page-title-control)\n\n[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/how-product-name-control-works)\n\n[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/shelf-template-controls)\n\n[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/control-to-disable-the-canonical-tag)\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)\n\n[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/can-i-order-my-product-as-i-want)\n\n[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/list-of-controls-for-templates)\n\n[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/creating-gift-lists)\n\n[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/validating-a-layout-before-moving-it-to-production)\n\n[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/how-to-use-the-page-title-control)\n\n[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/how-product-name-control-works)\n\n[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/shelf-template-controls)\n\n[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/control-to-disable-the-canonical-tag)\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/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-migrating-storefront-from-legacy-to-io/docs/storefront-development)\n\n(Legacy) CMS Portal\n\n[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)\n\nMigrating your storefront from Legacy CMS Portal to Store Framework\n\nVTEX provides different storefront solutions for you to choose from based on your operation’s needs: [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework) and [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore). However, there are still stores running the [Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj).\n\nIf your store uses Legacy CMS Portal, we strongly recommend migrating it to Store Framework. For implementation details, see the following sections.\n\n> If you wish to migrate your store from another commerce platform, the instructions below do not apply. In this case, follow the steps in the [Go Live guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live).\n\n## Instructions\n\nTo migrate your store from Legacy CMS Portal to [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework), follow these steps:\n\n1. [Setup workspaces](#step-1-setting-up-workspaces)\n2. [Develop and test](#step-2-developing-and-testing-your-storefront)\n3. [Go live](#step-3-going-live)\n\n> Consider planning the entire go-live process at least two weeks in advance, as some of the steps below are time-sensitive.\n\n### Step 1 - Setting up workspaces\n\n[Workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) are isolated environments, which means they can be understood as different versions of the same VTEX account.\n\nTo develop and test your store, we recommend that you create at least one [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) and one [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace). But it may be a good idea to create more workspaces based on your development needs. Learn how to manage workspaces effectively in [Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices).\n\n> Do not use subaccounts instead of [workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace). This can cause loss of Master Data information, including client profiles, and delays in project changes being displayed on the storefront due to cache unpredictability. It may even cause store downtime when going live with the new storefront.\n\n#### Setting the Edition app\n\nOnce you have created your workspaces, [open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) requesting the installation of the `vtex.edition-store@3.x` or a more recent version of the [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) in the workspaces created previously. Do not forget to include the names of the workspaces you wish to use in this process.\n\nTo check which version of the Edition app is installed in a workspace, run the following command: `vtex edition get`. Learn about its different versions in the [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) guide.\n\n> Do not request the Edition change for the master workspace of your store. This will cause some features, such as My Account, to stop working properly.\n\n### Step 2 - Developing and testing your storefront\n\nAt this point, it is up to your development team to plan and develop your store’s frontend experience. Check these guides to learn how to use VTEX IO to create amazing storefronts with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework):\n\n* [CMS IO basic concepts](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/4yB9wSl79cArd68aRBnBZ2)\n* [Storefront implementation overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation)\n* [Storefront apps overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps)\n* [Building a Store Framework theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3)\n\n### Step 3 - Going live\n\nOnce you have developed and tested your new storefront and everything is ready in a production workspace, it is time to go live. This means seamlessly switching the storefront being displayed to shoppers at your store’s domain. Follow these steps to accomplish this task:\n\n1. Promote the production workspace running your new storefront to master. Learn more about how to [promote a workspace to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master).\n2. Request VTEX internal DNS pointing change for Store Framework via [support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support). Use the ticket to schedule the change according to the information below at least three business days before your planned go-live date. This last step will cause your new storefront to go live.\n\nWhen opening the ticket, keep in mind that you must:\n\n* Open the ticket at least 3 days before the go-live date.\n* Request VTEX internal DNS pointing change only after you have promoted your production workspace to master.\n* Make it clear that you wish to go live in the ticket title.\n* Indicate a time from 9 a.m. to 5 p.m. (UTC-3) for the change to happen.\n* Indicate whether your store has any [trade policy conditional rules](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/criar-uma-politica-comercial--563tbcL0TYKEKeOY4IAgAE).\n\nContributors\n\n4\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/xeniabia)\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/guides/vtex-io/Storefront-Guides/vtex-io-documentation-going-live/vtex-io-documentation-migrating-storefront-from-legacy-to-io.md)\n\n[Installing apps on live stores« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io//docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices)[Can I order my product as I want?Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io//docs/guides/can-i-order-my-product-as-i-want)\n\nContributors\n\n4\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/xeniabia)\n\n[](https://github.com/mariana-caetano)\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-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23instructions)\n\n[Step 1 - Setting up workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-1-setting-up-workspaces)[Step 2 - Developing and testing your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-2-developing-and-testing-your-storefront)[Step 3 - Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-3-going-live)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-documentation-going-live/vtex-io-documentation-migrating-storefront-from-legacy-to-io.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-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23instructions)\n\n[Step 1 - Setting up workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-1-setting-up-workspaces)[Step 2 - Developing and testing your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-2-developing-and-testing-your-storefront)[Step 3 - Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io%23step-3-going-live)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_2db4d55d
|
[
{
"role": "system",
"content": "You are a VTEX 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 sdk overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-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/sdk-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/sdk-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/sdk-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/sdk-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/sdk-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/sdk-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/sdk-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/sdk-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-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/sdk-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-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/sdk-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/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/sdk-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-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/sdk-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/sdk-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-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/sdk-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/sdk-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-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/sdk-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/sdk-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-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/sdk-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-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/sdk-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/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/sdk-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-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/sdk-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/sdk-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-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/sdk-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/sdk-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/sdk-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore)\n\nFastStore SDK\n\nThe FastStore SDK is a toolkit that provides functions and interfaces for managing the state of key ecommerce features in the browser context. Providing a set of functions and interfaces simplifies tasks like tracking cart items and handling user sessions.\n\nThe SDK is organized into four modules with specific properties and behaviors. This track provides more details about each module.\n\n* [Cart](#cart)\n* [Session](#session)\n* [Search](#search)\n* [Analytics](#analytics)\n* [Getting started with the FastStore SDK](#getting-started-with-the-faststore-sdk) \n * [Usage](#usage) \n * [Inspecting browser data](#inspecting-browser-data)\n\n## Cart\n\nThe Cart module controls the state of the shopping cart data structure in the shopper's browser. You can use it to add items to the cart, remove items, and clear the cart, among other tasks. To learn more about this module, see the [Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/cart-overview) guide.\n\n> Learn more about validating the cart in the shopper browser against the information in the platform with [FastStore API mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations%23cart).\n\n## Session\n\nThe Session module manages the state of session information in the shopper browser. This includes currency, channel, localization, and shopper information. To learn more about this module, see the [Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-session) data structure and usage.\n\n> Learn more about validating the cart in the shopper browser against the information in the platform with [FastStore API mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations%23session).\n\n## Search\n\nThe Search module offers functions for implementing a faceted search based on URL parameters. Whenever a shopper searches your store or changes the selected facets, the search module generates a unique and serialized URL and then directs the user to that URL. To learn more about this module, see the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-overview) section.\n\n## Analytics\n\nThe Analytics module helps you create a simple, extensive event system to feed your data pool. It is geared towards [Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4) but supports other analytics providers. To learn more about this module, see the [Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview) section.\n\n## Getting started with the FastStore SDK\n\nInstall [@faststore/sdk](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) as a dependency of your FastStore project via the command line:\n\n### Usage\n\nThe FastStore SDK makes available different functions and hooks to manage essential ecommerce features. To use these functions and hooks, import them from the `@faststore/sdk` package.\n\nThe following example demonstrates how to manage a shopping cart using the `useCart` hook. It focuses on adding an item to the cart and displaying the cart's contents.\n\nIn the example, if the cart is empty, it shows a message indicating that the cart is empty. However, if the cart contains items, it lists each item's name, price, and quantity.\n\n`1\n\nyarn add @faststore/sdk \n\n`\n\n### Inspecting browser data\n\nYou can inspect browser data related to the session and shopping cart managed by the SDK when running your project locally. To do that, follow these steps:\n\n1. Run the command `yarn dev` from the root of your FastStore project.\n2. Open your local project preview at `http://localhost:3000`.\n3. Open the browser's developer console and run the following commands: \n * To view session data: `faststore_sdk_stores.get(\"fs::session\").read()`. \n * To view shopping cart data: `faststore_sdk_stores.get(\"fs::cart\").read()`.\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/overview.mdx)\n\n[Configuring GraphQL cache control for GET requests« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)[AnalyticsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/analytics-overview)\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/sdk-overview/docs/guides/faststore/sdk-overview%23cart)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23session)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23search)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23analytics)\n\n[Getting started with the FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23getting-started-with-the-faststore-sdk)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23usage)[Inspecting browser data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23inspecting-browser-data)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/overview.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/sdk-overview/docs/guides/faststore/sdk-overview%23cart)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23session)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23search)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23analytics)\n\n[Getting started with the FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23getting-started-with-the-faststore-sdk)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23usage)[Inspecting browser data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview/docs/guides/faststore/sdk-overview%23inspecting-browser-data)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_30fe62fe
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides data residency in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/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/data-residency/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/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/data-residency/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/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/data-residency/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/pii-data-architecture-specifications)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/profile-system)\n\n[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/working-with-schemas-in-the-profile-system)\n\n[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\n[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/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/data-residency/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/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/data-residency/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/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/data-residency/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/pii-data-architecture-specifications)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/profile-system)\n\n[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/working-with-schemas-in-the-profile-system)\n\n[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\n[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides)\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/data-protection-plus)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/data-residency)\n\nData residency\n\n> **Closed beta:** [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus) is in closed beta and is only available in select regions.\n\n> This feature is part of [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh), meaning _additional fees may apply._\n> \n> If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ).\n> \n> If you are not yet a customer but are interested in this solution, please complete our [contact form](https://read.calvincode.net/reader?url=https://vtex.com/us-en/contact/).\n\nThe VTEX data residency feature enables stores implementing [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus) to select the specific geographic region where all data saved in the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system) is stored, such as name, email, and shipping address, among others.\n\nIt is possible to choose the data residency location from two available options:\n\n* **AWS us-east-1:** located in Virginia, USA.\n* **AWS eu-west-1:** located in Ireland.\n\nThere are two instances of the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system) running in parallel, each based in different locations: US (Virginia) and EU (Ireland). These instances are identical in terms of their functioning. However, each instance only holds and processes data associated with stores that selected that location as their accounts' PII data residency. Profile System information is backed up in the same selected region, using [Amazon DynamoDB Point-in-time recovery (PITR)](https://read.calvincode.net/reader?url=https://aws.amazon.com/dynamodb/pitr).\n\nIn practice, when data is requested from the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system), the VTEX edge layer directs the request to the appropriate Profile System location based on the data residency location selected by the account, as illustrated below.\n\nAWS eu-west-1\n\nAWS us-east-1\n\nDatabase\n\nStorage entity\n\nRouter\n\nVTEX service\n\nStorage entity\n\nDatabase\n\n> The [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system) is the VTEX module responsible for keeping Shopper Profile PII at rest.\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/PedroAntunesCosta)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/data-privacy/data-residency.md)\n\n[PII Data Architecture specifications« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency//docs/guides/pii-data-architecture-specifications)[Profile System integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency//docs/guides/profile-system)\n\nSee also\n\n[Data Protection PlusGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/data-protection-plus)[Limitations of the PII data architecture during closed betaGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)[PII Data Architecture specificationsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/pii-data-architecture-specifications)[Profile System integrationGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/profile-system)[Changes in VTEX features behavior to handle PII dataGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/PedroAntunesCosta)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/data-privacy/data-residency.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_47c2bc7b
|
[
{
"role": "system",
"content": "You are a VTEX 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 iframe in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-iframe/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/api-reference)\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-iframe/docs/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-iframe/docs/storefront-development)\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-iframe/docs/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-iframe/docs/troubleshooting)\n\n[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-iframe/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/updates/release-notes)\n\nIframe\n\nAn app that makes it possible to render external iframes on a store.\n\n\n\n## Configuration - standard Iframe\n\n1. Add the `vtex.iframe` to the theme's dependencies on the `manifest.json`\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.iframe\": \"0.x\" \n\n3\n\n} \n\n`\n\n1. Add the interface `iframe` to any **custom page** (Iframes are not allowed outside custom pages).\n\n`1\n\n{ \n\n2\n\n \"store.custom#about-us\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"flex-layout.row#about-us\", \n\n5\n\n \"iframe\" \n\n6\n\n ] \n\n7\n\n }, \n\n8\n\n \n9\n\n \"iframe\": { \n\n10\n\n \"props\": { \n\n11\n\n \"src\": \"\" \n\n12\n\n } \n\n13\n\n } \n\n14\n\n} \n\n`\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------- | ------------- |\n| src | String | Source address the iframe should render | null |\n| width | Number | Width attribute of the iframe | null |\n| height | Number | Height attribute of the iframe | null |\n| allow | String | allow attribute of the iframe | null |\n\n## Configuration - dynamic Iframe\n\n1. Add the `vtex.iframe` to the theme's dependencies on the `manifest.json`\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.iframe\": \"0.x\" \n\n3\n\n} \n\n`\n\n1. Add the dynamicIframe block and its properties to the blocks.json file\n\n`1\n\n{ \n\n2\n\n \"store.custom#locationPage\":{ \n\n3\n\n \"children\":[ \n\n4\n\n \"iframe.dynamic-src\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \"iframe.dynamic-src\":{ \n\n8\n\n \"props\": { \n\n9\n\n \"dynamicSrc\": \"https://www.test.com/exampleStaticPathName/{dynamicParam1}/{dynamicParam2}/exampleStaticPageName\", \n\n10\n\n \"width\": \"1920\", \n\n11\n\n \"height\": \"1000\", \n\n12\n\n \"title\": \"exampleStaticPageName iframe wrapper for {account}\", \n\n13\n\n \"allow\": \"geolocation\" \n\n14\n\n } \n\n15\n\n } \n\n16\n\n} \n\n`\n\n1. register your new page in routes.json with appropriate parameters passed into the page url\n\n`1\n\n{ \n\n2\n\n \"store.custom#locationPage\":{ \n\n3\n\n \"path\": \"/:param1/:param2/pagename\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | ----------------------------------------------------------------- | ------------- |\n| dynamicSrc | String | iframe src with dynamic parameters from page URL enclosed in '{}' | null |\n| width | Number | Width attribute of the iframe | null |\n| height | Number | Height attribute of the iframe | null |\n| title | String | title attribute of the iframe | null |\n| allow | String | allow attribute of the iframe | null |\n\n## Customization\n\nThere is a `.container` handle that wraps the iframe, it's also possible to use `blockClass`.\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/advanced-components/vtex-iframe.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Configuration - standard Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%23configuration-standard-iframe)\n\n[Configuration - dynamic Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%23configuration-dynamic-iframe)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%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/advanced-components/vtex-iframe.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuration - standard Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%23configuration-standard-iframe)\n\n[Configuration - dynamic Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%23configuration-dynamic-iframe)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe/docs/guides/vtex-iframe%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_76d7ec27
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting my store does not reflect the overrides i created in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting)\n\nDevelopment\n\nMy store does not reflect the overrides I created\n\nDuring the Section overriding process, you can experience issues such as overridden components not appearing or not behaving as expected.\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview) is a feature for customizing and creating new components for your FastStore storefront. However, you may encounter situations where the overridden components don't appear or function as intended.\n\nBelow are various troubleshooting checks and instructions you can use to solve your store's issue:\n\n| Issue | Troubleshooting instructions |\n| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |\n| Overrides fail to display in your store. | [Check the getOverriddenSection function](#checking-the-getoverriddensection-function). |\n| The custom section is not available in the Headless CMS. | [Add the section’s schema in the Headless CMS](#adding-the-sections-schema-in-the-headless-cms). |\n| Overrides are not reflected in the Headless CMS. | [Remove default props](#removing-default-props). |\n| Styles are not being applied to the component. | [Check custom section class names](#checking-custom-section-class-names). |\n\n## Solution\n\nTo understand and correct each error, see the solutions below:\n\n### Checking the `getOverriddenSection` function\n\nIf you encounter an error message mentioning a missing function named `getOverriddenSection`, it means you need to import it into your code.\n\nThis function is important for displaying product overrides within your store, allowing you to customize specific product page sections. Follow the steps below to import the function to your project:\n\n1. Open the file where you are overriding the section, for example, `ProductDetailsWithCustomButton.tsx`.\n2. At the top of the file, import the `getOverridenSetion` function: \n`1 \n import { getOverriddenSection } from '@faststore/core'; \n` \nHere's an example of how to use `getOverriddenSection` in your `ProductDetailsWithCustomButton.tsx` file: \n`1 \nimport { ProductDetailsSection, getOverriddenSection } from '@faststore/core' \n2 \n \n3 \nconst ProductDetailsWithCustomButton = getOverriddenSection({ \n4 \nSection: ProductDetailsSection, \n5 \ncomponents: { \n6 \n BuyButton: { Component: CustomBuyButton }, \n7 \n}, \n8 \n}) \n`\n3. Run `yarn dev` to sync your changes with your development environment.\n\n### Adding the section’s schema in the Headless CMS\n\nIf you can't see the changes in the Headless CMS after [overriding a prop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props) or a [section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-native-component), this may be due to a missing schema. The Headless CMS will not display your custom section without one.\n\n1. [Add the schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms) for the new section to the Headless CMS.\n2. Replace the native section with your custom one. For detailed instructions, see the guide [Syncing components with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms).\n\n### Removing default props\n\nIf the changes you made after [overriding a prop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props) are not being reflected or not behaving as expected, this could be due to default prop definitions taking precedence. In this case, default props definitions may override yours when adding the section to the Headless CMS. Props changed via the Headless CMS take precedence over those defined in code through overrides. This can lead to confusion when you try to set a different default value in your code.\n\nConsider removing default values to ensure your overrides work.\n\n1. Identify the property you want to modify.\n2. Check if the property has a default value set in the Admin.\n3. If the property has a default value set in the Admin, open the `sections.json` file in your store code and find the property you want to change.\n4. Remove the default value from your code.\n5. Run `yarn cms sync` to sync the changes.\n\n### Checking custom section class names\n\nIf the style you created is not being applied, make sure that the `className` added to the section matches the one declared in the stylesheet. For instance, if you declared `className: styles.simpleAlert` in the section, ensure that the corresponding style declaration in the stylesheet is `.simpleAlert`.\n\nFor more information, see the [Override section styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles) article.\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-store-does-not-reflect-the-overrides-i-created.md)\n\n[My pages are taking too long to be published on Headless CMS« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)[Modal Layout closes when I click a SKUNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\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-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created%23solution)\n\n[Checking the getOverriddenSection function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created%23checking-the-getoverriddensection-function)[Adding the section’s schema in the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created%23adding-the-sections-schema-in-the-headless-cms)[Removing default props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created%23removing-default-props)[Checking custom section class names](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created%23checking-custom-section-class-names)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/my-store-does-not-reflect-the-overrides-i-created.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created%23solution)\n\n[Checking the getOverriddenSection function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created%23checking-the-getoverriddensection-function)[Adding the section’s schema in the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created%23adding-the-sections-schema-in-the-headless-cms)[Removing default props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created%23removing-default-props)[Checking custom section class names](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created%23checking-custom-section-class-names)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_04d0d8d0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting my store is slow or unavailable in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/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/my-store-is-slow-or-unavailable/docs/troubleshooting)\n\nStore performance\n\nMy store is slow or unavailable\n\nIf you are experiencing slow or non-functional operations in your store, there could be several underlying reasons.\n\nKeywords: performance | platform status | slow | unavailable | platform issues\n\nIf you are experiencing issues with your store, it is important to first determine whether the problem is that the store is unavailable or operating slowly. Identifying the specific issue will help you address it more effectively:\n\n| Issue | Description | Solutions |\n| ------------------------ | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Store is unavailable** | The store stopped functioning or had a go-live failure. | 1\\. [Checking VTEX Status page](#checking-vtex-status-page)2\\. [Checking your connection](#checking-your-connection)3\\. [Verifying DNS configuration](#if-the-store-is-unavailable-verifying-dns-configuration)4\\. [Checking your storefront code and settings](#checking-your-storefront-code-and-settings) |\n| **Store is slow** | Shopping operations work, but slowly. It takes longer than expected to load or perform actions. | 1\\. [Checking VTEX Status page](#checking-vtex-status-page)2\\. [Checking your connection](#checking-your-connection) 3\\. [Reviewing customizations and integrations](#if-the-store-is-slow-reviewing-customizations-and-integrations)4\\. [Checking your storefront code and settings](#checking-your-storefront-code-and-settings) |\n\nOnce you identify whether your store is unavailable or slow, follow the listed troubleshooting steps to solve the issue.\n\n## Solutions\n\nBelow are various troubleshooting checks and instructions you can use to solve your store's issue.\n\n### Checking VTEX Status page\n\nRefer to the [VTEX status page](https://read.calvincode.net/reader?url=https://status.vtex.com) to check if the platform is undergoing some instability. If the status page indicates that the platform is functioning normally, move on to the next solutions.\n\n> When you initially check the status page, there may be unreported instabilities, especially if it is a recent incident. Therefore, it is recommended that you periodically monitor the status page while following the troubleshooting steps provided.\n\n### Checking your connection\n\nVerify your internet connection by visiting other websites to ensure it is functioning properly. Alternatively, attempt to access your store using a different internet connection.\n\nIf the issues persist, refer to the recommendations below based on the issue you are experiencing.\n\n### If the store is unavailable: Verifying DNS configuration\n\nIf your store had a go-live failure or was functioning normally and then stopped, see the topics below.\n\n| Topic | Required action |\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Account in production** | Your account must be set to production. Otherwise, it will not be live. See this article for instructions on how to [put your account into production](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/7wFsbWgN4rnZsbjhv8IItX%23putting-your-account-into-production). |\n| **CDN domain registration** | If you have registered your store's domain with the same CDN provider that VTEX uses (Cloudfront), it may cause issues with CDN provisioning and result in a go-live failure. To avoid this, please refer to the go-live guide for instructions on how to resolve any conflicts related to [CDN domain registration](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/7wFsbWgN4rnZsbjhv8IItX%23checking-domain-in-cdns). |\n| **CNAME Type A pointing** | Your DNS pointing must be of the type CNAME. There can not be any type A pointing coexisting with the CNAME, otherwise your go-live will most likely fail. Learn more about how to [set up DNS pointing to VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/12bQlMbJ68Ot0LIaO6Btkj%23setting-up-dns-pointing). |\n| **SSL certificate** | If your store failed to go-live after you [notified DNS pointing](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/12bQlMbJ68Ot0LIaO6Btkj%23notifying-the-pointing), it may be that there was a failure to generate your SSL certificate. Refer to this guide to learn how to identify this issue and what to do in case of problems after [DNS pointing notification](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/12bQlMbJ68Ot0LIaO6Btkj%23notifying-the-pointing) |\n| **DNS provider settings** | If you have not configured your DNS provider settings properly, VTEX may not be able to generate the SSL certificate, leading to store unavailability. See this guide on how to [Set up DNS pointing to VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/12bQlMbJ68Ot0LIaO6Btkj) and double check your DNS provider settings. |\n| **DNS propagation** | DNS propagation may take up to 48 hours after [DNS pointing](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/12bQlMbJ68Ot0LIaO6Btkj%23setting-up-dns-pointing). The length of this period depends on the Time To Live (TTL) you configured in your DNS provider. If you are within this timeframe, the store may not be accessible yet. Please be patient and allow sufficient time for DNS propagation to complete. |\n| **DNS pointing deadline** | Once you register your domain in VTEX, you have up to seven days to set up DNS pointing. If you miss this deadline, you must [register your domain in VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/7sM5IMx02zaHvAFTm0OxiJ%23registering-the-domain-on-vtex) again. See the [go-live guide](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/1iP90RcJvlrfQhnlxM54wo) to learn details about this process. |\n| **Cloudflare proxy** | If [Cloudflare](https://read.calvincode.net/reader?url=https://www.cloudflare.com/) is your DNS provider, their native proxy can interfere with the SSL certificate, causing your store to go down. If this is your case, learn [how to disable the Cloudflare proxy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/disable-cloudflare-proxy--75QqsXAqR7NdkRc1GZPiXb). |\n| **Reverse proxy** | [Reverse proxy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-insert-a-reverse-proxy-in-front-of-vtex-services--4PFWsfRAKviNVPf1bYdiir) malfunction can cause store availability issues. When you use a reverse proxy, you give up the optimized edge service managed by VTEX and are responsible for the site's actual provisioning, which is tasked with the settings, monitoring and feature management such as header forwarding, cookies and cache management.If this is your case, you can see this article on [How to insert a reverse proxy in front of VTEX services](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-insert-a-reverse-proxy-in-front-of-vtex-services--4PFWsfRAKviNVPf1bYdiir) and follow up with your infrastructure team or provider to learn if this is the cause of your problem.❗ **VTEX does not recommend using reverse proxies.** |\n\nIf the issue persists, you can find additional troubleshooting steps below for [Checking your storefront code and settings](#checking-your-storefront-code-and-settings).\n\n### If the store is slow: Reviewing customizations and integrations\n\nThe VTEX platform is designed to be multi-tenant and autoscalable, which means the platform can handle several merchants' needs simultaneously without impacting individual store performance.\n\nTo maintain the platform's overall health, VTEX may occasionally throttle unintentionally abusive requests. Therefore, if you notice slow performance, it is recommended to review your storefront code customizations and composable integrations.\n\nEnsure that these elements are not generating excessive requests to VTEX, as this can lead to throttling issues or bottlenecks for your store. By optimizing your requests and ensuring they are within acceptable limits, you can improve the overall performance of your store while ensuring compliance with VTEX's request throttling mechanisms.\n\nIf the issue persists, you can find additional troubleshooting steps below for [Checking your storefront code and settings](#checking-your-storefront-code-and-settings).\n\n### Checking your storefront code and settings\n\nDepending on your selected storefront development solution, there are additional steps for troubleshooting a slow or unavailable store.\n\n#### Store Framework\n\nIf your store uses [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework) and the topics above have not helped you, see the instructions below.\n\n* **Edition App compatibility:** \nIf your [go-live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live) or [storefront migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io) has failed, it may be a good idea to check if you have the correct [account edition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live%23account-edition).\n* **Store Framework performance optimization:** \nIf your store is slow, check this [performance optimization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance) and implement the recommended settings.\n\n#### FastStore\n\nIf your store uses [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore) and the topics above have not helped you, see the instructions below.\n\n* **Publishing failures** \nSee this guide on [Debugging Releases and VTEX Headless CMS publishing errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms).\n* **Lighthouse tests** \n[Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview) is an open-source tool that helps developers assess website performance. FastStore projects run automatic Lighthouse tests with every pull request. You need to consider the results of these automatic tests to identify and mitigate any performance issues before they impact your store in production. \n> Learn more about [using Lighthouse in your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23lighthouse-scores).\n* **Data fetching** \nData fetching can negatively impact your storefront's performance if not done correctly on FastStore. See the [Best practices for fetching data on your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview%23best-practices-for-fetching-data) and make sure they are implemented.\n* **Third-party scripts** \n[Third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts) on FastStore may also cause your site to be slow. See this article to learn [how to handle the impact of third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts) on your FastStore project.\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\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/store-performance/my-store-is-slow-or-unavailable.md)\n\n[I can't complete a purchase on a FastStore website« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website)[Google Analytics 4 is tracking inconsistent data from my storeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23solutions)\n\n[Checking VTEX Status page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23checking-vtex-status-page)[Checking your connection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23checking-your-connection)[If the store is unavailable: Verifying DNS configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23if-the-store-is-unavailable-verifying-dns-configuration)[If the store is slow: Reviewing customizations and integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23if-the-store-is-slow-reviewing-customizations-and-integrations)[Checking your storefront code and settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23checking-your-storefront-code-and-settings)\n\nWas this helpful?\n\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/my-store-is-slow-or-unavailable.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23solutions)\n\n[Checking VTEX Status page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23checking-vtex-status-page)[Checking your connection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23checking-your-connection)[If the store is unavailable: Verifying DNS configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23if-the-store-is-unavailable-verifying-dns-configuration)[If the store is slow: Reviewing customizations and integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23if-the-store-is-slow-reviewing-customizations-and-integrations)[Checking your storefront code and settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-slow-or-unavailable/docs/troubleshooting/my-store-is-slow-or-unavailable%23checking-your-storefront-code-and-settings)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e80b298f
|
[
{
"role": "system",
"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 unable to access 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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-headless-cms/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/unable-to-access-headless-cms/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/unable-to-access-headless-cms/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/unable-to-access-headless-cms/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/unable-to-access-headless-cms/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/unable-to-access-headless-cms/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-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/unable-to-access-headless-cms/docs/troubleshooting)\n\nDevelopment\n\nI can’t access the Headless CMS\n\nPermission denied error in faststore cms-sync or vtex cms sync indicates user access issues.\n\n**Keywords:** Headless CMS | FastStore| CLI\n\nIf you encounter the error `Error: Permission denied` or `Error: User indicated by VtexIdclientAutCookie is not authorized to access the indicated resource` when using `faststore cms-sync` or `vtex cms sync`, this issue is related to the user permissions needed to execute the command and save resources.\n\n## Solution\n\nTo solve this problem, ask the user who granted your user Admin access to follow the steps below:\n\n### Granting user Admin access\n\n1. Open the VTEX Admin and go to **Account Settings > User Roles.** \n\n2. Under **Roles**, select the role associated with the user requesting CMS permissions. For example, **Owner (Admin Super)**.\n3. In **Products and Resources**, find and click **CMS**. \n\n4. Make sure both **See CMS menu on the top-bar** and **Settings** are checked.\n5. Navigate to the **Users** section and add the email of the user who needs access to the CMS.\n6. Click `Save`. Ask the user who requested access to run the `faststore cms-sync` or `vtex cms sync` command again. They should now be able to sync their changes.\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/unable-to-access-headless-cms.md)\n\n[Issues during extending the FastStore API schema« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/unable-to-access-headless-cms/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)[I can’t install the Headless CMS plugins in my accountNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/unable-to-access-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\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/unable-to-access-headless-cms/docs/troubleshooting/unable-to-access-headless-cms%23solution)\n\n[Granting user Admin access](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/unable-to-access-headless-cms/docs/troubleshooting/unable-to-access-headless-cms%23granting-user-admin-access)\n\nWas this helpful?\n\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/unable-to-access-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/unable-to-access-headless-cms/docs/troubleshooting/unable-to-access-headless-cms%23solution)\n\n[Granting user Admin access](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/unable-to-access-headless-cms/docs/troubleshooting/unable-to-access-headless-cms%23granting-user-admin-access)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_276a8aab
|
[
{
"role": "system",
"content": "You are a VTEX 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 hotjar in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-hotjar/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar/docs/api-reference)\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-hotjar/docs/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-hotjar/docs/storefront-development)\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-hotjar/docs/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-hotjar/docs/troubleshooting)\n\n[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-hotjar/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar/updates/release-notes)\n\nHotjar\n\nOpen the VTEX APP Store and install the app on your store.\n\nor\n\nRun the following command:\n\n`1\n\nvtex install vtex.hotjar@0.x \n\n`\n\nNext, open the app settings on your admin and fill the form with Site ID.\n\n### Setup in Cart and Checkout page\n\nOpen your admin in the Checkout section in the `checkout6-custom.js`:\n\n<https://ACCOUNT.myvtex.com/admin/portal/#/sites/default/code/files/checkout6-custom.js>\n\nAdd the following snippet in the file and replace `\"YOURSITEID\"` with your Site ID:\n\n`1\n\n// Hotjar \n\n2\n\n(function(h,o,t,j,a,r){ \n\n3\n\n var siteId = 'YOURSITEID'; \n\n4\n\n h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)}; \n\n5\n\n h._hjSettings={hjid:siteId,hjsv:6}; \n\n6\n\n a=o.getElementsByTagName('head')[0]; \n\n7\n\n r=o.createElement('script');r.async=1; \n\n8\n\n r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv; \n\n9\n\n a.appendChild(r); \n\n10\n\n})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv='); \n\n`\n\nClick Save.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/pixel-apps/vtex-hotjar.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Setup in Cart and Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar/docs/guides/vtex-hotjar%23setup-in-cart-and-checkout-page)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/pixel-apps/vtex-hotjar.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Setup in Cart and Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar/docs/guides/vtex-hotjar%23setup-in-cart-and-checkout-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_4a468d61
|
[
{
"role": "system",
"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 orders api pii version 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/orders-api-pii-version/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/api-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/orders-api-pii-version/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/orders-api-pii-version/docs/storefront-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/orders-api-pii-version/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/orders-api-pii-version/docs/troubleshooting)\n\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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/orders-api-pii-version/)\n\nOrders - PII Data Architecture\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/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/orders-api-pii-version/docs/api-reference/orders-api-pii-version/)\n\nOrders - PII Data Architecture\n\n---\n\n[GeGet unmasked profile information« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/purchase-info/unmask)[GeGet orderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version/docs/api-reference/orders-api-pii-version%23get-/api/orders/pvt/document/-orderId-)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_6d68f39b
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting i cant install an app with a major other than 0x in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\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/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/i-cant-create-a-new-workspace)\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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/updates/release-notes)\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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\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/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/i-cant-create-a-new-workspace)\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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/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/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting)\n\nDevelopment\n\nI can't install an app with a major other than 0.x\n\nThe app major conflicts with the installed Edition App.\n\n**Keywords:** Apps | Edition App\n\nIf you're unable to install an app with a major [version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version%23understanding-app-versioning) other than `0.x`, follow the instructions below.\n\n\n\n## Solution\n\nRun `vtex ls` to check which apps are included on the [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) installed on your account. If you see the app you're trying to install with another major, there might be an issue with the Edition App installed on your account.\n\nIf this is the case, consider [opening a support ticket](https://read.calvincode.net/reader?url=https://support.vtex.com/hc/en-us/requests) to request a change to the Edition App installed on your account. See the [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) article to learn more about the available Edition Apps.\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/i-cant-install-an-app-with-a-major-other-than-0x.md)\n\n[I can't create a new workspace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/i-cant-create-a-new-workspace)[I don't see my Store Theme changesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/i-dont-see-my-store-theme-changes)\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/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x%23solution)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-install-an-app-with-a-major-other-than-0x.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/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x%23solution)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4b8382b6
|
[
{
"role": "system",
"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 productsummaryshelf 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/ProductSummaryShelf/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/ProductSummaryShelf/docs/api-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/ProductSummaryShelf/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/ProductSummaryShelf/docs/storefront-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/ProductSummaryShelf/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/ProductSummaryShelf/docs/troubleshooting)\n\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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/docs/vtex-io-apps)\n\nProduct Summary Shelf\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 Shelf is the main block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary). It includes the child blocks required to display the Product Summary component in your store.\n\n\n\n) \n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme dependencies in the `manifest.json` file:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary.shelf` block as a child of the [list-context.product-list block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist%23product-list-block):\n\n`1\n\n \"list-context.product-list\": { \n\n2\n\n+ \"blocks\": [\"product-summary.shelf\"] \n\n3\n\n }, \n\n`\n\n1. Declare the `product-summary.shelf` block, passing the desired blocks exported by the Product Summary app to build your Product Summary component. For example:\n\n`1\n\n{ \n\n2\n\n+ \"product-summary.shelf\": { \n\n3\n\n+ \"children\": [ \n\n4\n\n+ \"product-summary-image\", \n\n5\n\n+ \"product-summary-name\", \n\n6\n\n+ \"product-rating-inline\", \n\n7\n\n+ \"product-summary-space\", \n\n8\n\n+ \"product-summary-price\", \n\n9\n\n+ \"product-summary-buy-button\" \n\n10\n\n+ ] \n\n11\n\n+ } \n\n12\n\n} \n\n`\n\n> Remember to define the other Product Summary blocks in your theme, otherwise the component will not be displayed.\n\n| Prop name | Type | Description | Default value |\n| ---------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |\n| priceBehavior | enum | Determines whether the component should fetch the most up-to-date price (async) or (default). Remember to configure the [Search Result](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/content-blocks/vtex.search-result@3.79.1/%23configuration)'s simulationBehavior prop to skip and use the Product Price [product-price-suspense](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/product-price/blob/master/docs/README.md) block to render a loading spinner while the price information is being fetched. | default |\n| trackListName | boolean | Determines whether the component should send the list name to the product page when the product summary is clicked. Disabling it will prevent the productDetail GTM event sent on the PDP to identify from which list the user navigated. | true |\n| sponsoredBadgeLabel | String | The text of the \"Sponsored\" tag, if applicable. | \"store/sponsored-badge.label\" |\n| sponsoredBadgePosition | enum | The position of the \"Sponsored\" tag, if applicable. Possible values are titleTop, containerTopLeft and none. | \"containerTopLeft\" |\n\n## Customization\n\nThe Product Summary Shelf merely establishes the block structure to render the Product Summary component. Therefore, this block does not have CSS Handles for its specific customization.\n\nInstead, you should use its child block Handles.\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/ProductSummaryShelf/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/ProductSummaryShelf/docs/apps/vtex.product-summary/ProductSummaryShelf%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/docs/apps/vtex.product-summary/ProductSummaryShelf%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_56ebfed8
|
[
{
"role": "system",
"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 list 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-list/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-list/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/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-list/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/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-list/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/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-list/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-list/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-list/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/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-list/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/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-list/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/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-list/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-list/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-list/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/guides/basic-components)\n\nProduct List\n\nOfficial extension\n\nVersion: 0.37.4\n\nLatest version: 0.37.4\n\n[](#contributors-)\n\nThe Product List component displays all items in the user's cart and informs users when items are unavailable.\n\n> Currently, the Product List only works with [Minicart v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/).\n\n\n\n## Configuration\n\n1. Add the Product List app to your theme dependencies in `manifest.json`. For example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.product-list\": \"0.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-list` block to the `minicart-product-list` block (exported by the Minicart app). For example:\n\n`1\n\n \"minicart-product-list#example\": { \n\n2\n\n \"blocks\": [\"product-list\"] \n\n3\n\n } \n\n`\n\nOnce you have added the `product-list` to the `minicart-product-list`, no further actions are required, as the block works with a default implementation behind the scenes. This means that the Product List component is ready to be rendered.\n\n### Advanced configuration\n\nCurrently, the `product-list` default implementation is the following:\n\n`1\n\n{ \n\n2\n\n \"product-list\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"product-list-content-desktop\", \n\n5\n\n \"product-list-content-mobile\" \n\n6\n\n ] \n\n7\n\n }, \n\n8\n\n \"product-list-content-desktop\": { \n\n9\n\n \"children\": [\"flex-layout.row#list-row.desktop\"] \n\n10\n\n }, \n\n11\n\n \"flex-layout.row#list-row.desktop\": { \n\n12\n\n \"children\": [ \n\n13\n\n \"flex-layout.col#image.desktop\", \n\n14\n\n \"flex-layout.col#main-container.desktop\" \n\n15\n\n ], \n\n16\n\n \"props\": { \n\n17\n\n \"fullWidth\": true, \n\n18\n\n \"paddingBottom\": \"7\", \n\n19\n\n \"paddingTop\": \"6\", \n\n20\n\n \"colSizing\": \"auto\", \n\n21\n\n \"preserveLayoutOnMobile\": \"true\" \n\n22\n\n } \n\n23\n\n }, \n\n24\n\n \"flex-layout.col#image.desktop\": { \n\n25\n\n \"children\": [\"product-list-image\"], \n\n26\n\n \"props\": { \n\n27\n\n \"marginRight\": \"6\" \n\n28\n\n } \n\n29\n\n }, \n\n30\n\n \"flex-layout.col#main-container.desktop\": { \n\n31\n\n \"children\": [ \n\n32\n\n \"flex-layout.row#sub-container.desktop\", \n\n33\n\n \"flex-layout.row#message.desktop\" \n\n34\n\n ], \n\n35\n\n \"props\": { \n\n36\n\n \"width\": \"grow\" \n\n37\n\n } \n\n38\n\n }, \n\n39\n\n \"flex-layout.row#sub-container.desktop\": { \n\n40\n\n \"children\": [ \n\n41\n\n \"flex-layout.col#product-description\", \n\n42\n\n \"flex-layout.col#quantity.desktop\", \n\n43\n\n \"flex-layout.row#price-remove\" \n\n44\n\n ], \n\n45\n\n \"props\": { \n\n46\n\n \"preserveLayoutOnMobile\": \"true\", \n\n47\n\n \"colSizing\": \"auto\" \n\n48\n\n } \n\n49\n\n }, \n\n50\n\n \"flex-layout.col#quantity.desktop\": { \n\n51\n\n \"children\": [ \n\n52\n\n \"flex-layout.row#quantity-selector.desktop\", \n\n53\n\n \"flex-layout.row#unit-price.desktop\" \n\n54\n\n ], \n\n55\n\n \"props\": { \n\n56\n\n \"marginLeft\": \"8\" \n\n57\n\n } \n\n58\n\n }, \n\n59\n\n \"flex-layout.row#price-remove\": { \n\n60\n\n \"children\": [ \n\n61\n\n \"flex-layout.col#price.desktop\", \n\n62\n\n \"flex-layout.col#remove-button.desktop\" \n\n63\n\n ], \n\n64\n\n \"props\": { \n\n65\n\n \"colSizing\": \"auto\" \n\n66\n\n } \n\n67\n\n }, \n\n68\n\n \"flex-layout.row#quantity-selector.desktop\": { \n\n69\n\n \"children\": [\"quantity-selector\"], \n\n70\n\n \"props\": { \n\n71\n\n \"preventHorizontalStretch\": \"true\" \n\n72\n\n } \n\n73\n\n }, \n\n74\n\n \"flex-layout.row#unit-price.desktop\": { \n\n75\n\n \"children\": [\"unit-price#desktop\"], \n\n76\n\n \"props\": { \n\n77\n\n \"marginTop\": \"3\", \n\n78\n\n \"preventHorizontalStretch\": \"true\" \n\n79\n\n } \n\n80\n\n }, \n\n81\n\n \"unit-price#desktop\": { \n\n82\n\n \"props\": { \n\n83\n\n \"textAlign\": \"center\" \n\n84\n\n } \n\n85\n\n }, \n\n86\n\n \"flex-layout.col#price.desktop\": { \n\n87\n\n \"children\": [\"price#desktop\"], \n\n88\n\n \"props\": { \n\n89\n\n \"blockClass\": \"priceWrapper\", \n\n90\n\n \"marginLeft\": \"6\", \n\n91\n\n \"preventHorizontalStretch\": \"true\", \n\n92\n\n \"verticalAlign\": \"middle\" \n\n93\n\n } \n\n94\n\n }, \n\n95\n\n \"price#desktop\": { \n\n96\n\n \"props\": { \n\n97\n\n \"textAlign\": \"right\" \n\n98\n\n } \n\n99\n\n }, \n\n100\n\n \"flex-layout.col#remove-button.desktop\": { \n\n101\n\n \"children\": [\"remove-button\"], \n\n102\n\n \"props\": { \n\n103\n\n \"marginLeft\": \"6\", \n\n104\n\n \"verticalAlign\": \"middle\" \n\n105\n\n } \n\n106\n\n }, \n\n107\n\n \"flex-layout.row#message.desktop\": { \n\n108\n\n \"children\": [\"message#desktop\"], \n\n109\n\n \"props\": { \n\n110\n\n \"marginTop\": \"4\" \n\n111\n\n } \n\n112\n\n }, \n\n113\n\n \"message#desktop\": { \n\n114\n\n \"props\": { \n\n115\n\n \"layout\": \"cols\" \n\n116\n\n } \n\n117\n\n }, \n\n118\n\n \"product-list-content-mobile\": { \n\n119\n\n \"children\": [\"flex-layout.row#list-row.mobile\"] \n\n120\n\n }, \n\n121\n\n \"flex-layout.row#list-row.mobile\": { \n\n122\n\n \"children\": [ \n\n123\n\n \"flex-layout.col#image.mobile\", \n\n124\n\n \"flex-layout.col#main-container.mobile\" \n\n125\n\n ], \n\n126\n\n \"props\": { \n\n127\n\n \"fullWidth\": true, \n\n128\n\n \"paddingBottom\": \"6\", \n\n129\n\n \"paddingTop\": \"5\", \n\n130\n\n \"colSizing\": \"auto\", \n\n131\n\n \"preserveLayoutOnMobile\": \"true\" \n\n132\n\n } \n\n133\n\n }, \n\n134\n\n \"flex-layout.col#image.mobile\": { \n\n135\n\n \"children\": [\"product-list-image\"], \n\n136\n\n \"props\": { \n\n137\n\n \"marginRight\": \"5\" \n\n138\n\n } \n\n139\n\n }, \n\n140\n\n \"flex-layout.col#main-container.mobile\": { \n\n141\n\n \"children\": [ \n\n142\n\n \"flex-layout.row#top.mobile\", \n\n143\n\n \"flex-layout.row#quantity-selector.mobile\", \n\n144\n\n \"flex-layout.row#unit-price.mobile\", \n\n145\n\n \"flex-layout.row#price.mobile\", \n\n146\n\n \"flex-layout.row#message.mobile\" \n\n147\n\n ], \n\n148\n\n \"props\": { \n\n149\n\n \"width\": \"grow\" \n\n150\n\n } \n\n151\n\n }, \n\n152\n\n \"flex-layout.row#top.mobile\": { \n\n153\n\n \"children\": [ \n\n154\n\n \"flex-layout.col#product-description\", \n\n155\n\n \"flex-layout.col#remove-button.mobile\" \n\n156\n\n ], \n\n157\n\n \"props\": { \n\n158\n\n \"colSizing\": \"auto\", \n\n159\n\n \"preserveLayoutOnMobile\": \"true\" \n\n160\n\n } \n\n161\n\n }, \n\n162\n\n \"flex-layout.row#quantity-selector.mobile\": { \n\n163\n\n \"children\": [\"quantity-selector\"], \n\n164\n\n \"props\": { \n\n165\n\n \"marginTop\": \"5\", \n\n166\n\n \"preventHorizontalStretch\": \"true\" \n\n167\n\n } \n\n168\n\n }, \n\n169\n\n \"flex-layout.row#unit-price.mobile\": { \n\n170\n\n \"children\": [\"unit-price\"], \n\n171\n\n \"props\": { \n\n172\n\n \"marginTop\": \"3\" \n\n173\n\n } \n\n174\n\n }, \n\n175\n\n \"flex-layout.row#price.mobile\": { \n\n176\n\n \"children\": [\"price#mobile\"], \n\n177\n\n \"props\": { \n\n178\n\n \"marginTop\": \"5\", \n\n179\n\n \"preventHorizontalStretch\": \"true\" \n\n180\n\n } \n\n181\n\n }, \n\n182\n\n \"price#mobile\": { \n\n183\n\n \"props\": { \n\n184\n\n \"textAlign\": \"left\" \n\n185\n\n } \n\n186\n\n }, \n\n187\n\n \"flex-layout.col#remove-button.mobile\": { \n\n188\n\n \"children\": [\"remove-button\"], \n\n189\n\n \"props\": { \n\n190\n\n \"marginLeft\": \"3\" \n\n191\n\n } \n\n192\n\n }, \n\n193\n\n \"flex-layout.row#message.mobile\": { \n\n194\n\n \"children\": [\"message#mobile\"], \n\n195\n\n \"props\": { \n\n196\n\n \"marginTop\": \"3\" \n\n197\n\n } \n\n198\n\n }, \n\n199\n\n \"message#mobile\": { \n\n200\n\n \"props\": { \n\n201\n\n \"layout\": \"rows\" \n\n202\n\n } \n\n203\n\n } \n\n204\n\n} \n\n`\n\nThe default implementation means that whenever you declare the `product-list` block in your store, you are actually telling your theme to render the above `json` behind the scenes.\n\nIn order to customize the `product-list` configuration, copy the code above, paste it, and change it as you wish.\n\n| Block name | Description |\n| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| product-list |  Top level block that must be declared in the minicart-product-list block to render a default detailed list with all products added to the shopping cart. |\n| product-list-content-desktop | Creates the product list layout for desktop devices. |\n| product-list-content-mobile | Creates the product list layout for mobile devices. |\n| message | Renders a message about the product availability. |\n| product-name | Renders the product names. |\n| product-reference | Renders the product reference information. |\n| price | Renders the product prices. |\n| unit-price | Renders the price for each unit of the product added to the cart. |\n| product-list-image | Renders the product images. |\n| product-brand | Renders the product brands. |\n| product-variations | Renders the product variations. |\n| product-quantity-label | Renders a product label that displays the number of items added to the cart. |\n| quantity-selector | Renders a selector that allows users to choose how many units of a product they want to add to the cart. |\n| remove-button | Renders a button that allows users to remove a product from the list. |\n\n### `minicart-product-list` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| splitItem | boolean | Determines whether products with attachments should be split and treated as individual items (true) or as a single item (false) when their quantity is increased in the minicart. | false |\n\n### `product-list` props\n\n| Prop name | Type | Description | Default value |\n| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| itemCountMode | enum | Quantity badge behavior when displaying the total number of items added in Minicart. Possible values are: total (the quantity badge displays the number of items added to the cart), distinct (the quantity badge only displays the number of different products added to the cart), totalAvailable (the quantity badge displays the number of available items added to the cart), and distinctAvailable (the quantity badge only displays the number of different and available products added to the cart). | distinct |\n| lazyRenderHeight | number | The height (px) of each item loading element. | 100 |\n| lazyRenderOffset | number | The distance (px) that each item should be from the viewport at the time of its rendering. | 300 |\n\n### `message` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| layout | enum | Position of the availability message in the list. Possible values are: rows (displaying the message in the product row) or cols (displaying the message in the product column). | cols |\n\n### `price` props\n\n| Prop name | Type | Description | Default value |\n| ------------- | ------- | ------------------------------------------------------------------------------ | ------------- |\n| textAlign | string | Position of the product's price in the list. | left |\n| showListPrice | boolean | Whether the product prices should be displayed in the list: (true) or (false). | true |\n\n### `unit-price` props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| textAlign | string | Position of the product's unit price in the list. | left |\n| unitPriceType | enum | Defines whether the price type should be displayed. Possible values are: sellingPrice or price | price |\n| unitPriceDisplay | enum | Defines when the unit price should be displayed. Possible values are: always (unit price is always displayed) or default (unit price is only displayed when the number of products is greater than one). | default |\n| displayUnitListPrice | enum | Defines whether the product list price should be displayed. Possible values are: showWhenDifferent (the list price is displayed when it is different from the regular price), and notShow (the list price is never displayed). | notShow |\n\n### `product-list-image` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | -------------------------------- | ------------- |\n| width | number | Product image width (in pixels). | 96 |\n\n### `product-reference` props\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |\n| identifierLabel | string | Text label to be displayed to the left of the product reference value. | undefined |\n| identifyOption | enum | Desired product reference data, i.e., product identifier, to be displayed. Possible options are: ProductId, ProductSkuItemId, ProductReferenceId, and ProductSkuReferenceId. | ProductReferenceId |\n\n### `remove-button` props\n\n| Prop name | Type | Description | Default value |\n| ----------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| variation | enum | Variation for the button's visual prominence based on the [VTEX Styleguide](https://read.calvincode.net/reader?url=https://styleguide.vtex.com/%23/Components/Forms/Button). Possible values are: primary, secondary, tertiary, inverted-tertiary, danger, and danger-tertiary. | danger |\n| displayMode | enum | Defines how the remove button should be displayed. Possible values are: icon-button (renders an icon button), and text-button (renders a text message button). If you want to [create a modal in the remove button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons), use the icon-button value. | icon-button |\n\n### `quantity-selector` props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |\n| mode | enum | Type of quantity selector input. Possible values are default, and stepper. In the default mode, the quantity stepper will initially render a dropdown component, and after the quantity exceeds 10, it will switch to an input. The stepper mode will always render a numeric stepper component. | default |\n| quantitySelectorStep | enum | Defines how the number of products that have unitMultiplier will work. Possible values are: singleUnit (the quantity will be not affected with the unitMultiplier), and unitMultiplier (the quantity will be affected with the unitMultiplier). | unitMultiplier |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the instructions in [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ---------------------------------- |\n| availabilityMessageContainer |\n| availabilityMessageTextContainer |\n| availabilityMessageText |\n| productBrandName |\n| productImageAnchor |\n| productImageContainer |\n| productImage |\n| productListAvailableItemsMessage |\n| productListItem |\n| productListUnavailableItemsMessage |\n| productName |\n| productPriceContainer |\n| productPriceCurrency |\n| productPrice |\n| productQuantityLabel |\n| productIdentifier |\n| productIdentifierValue |\n| productIdentifierLabelValue |\n| productVariationsContainer |\n| productVariationsItem |\n| quantityDropdownContainer |\n| quantityDropdownMobileContainer |\n| quantityInputContainer |\n| quantityInputMobileContainer |\n| quantitySelectorContainer |\n| quantitySelectorWrapper |\n| quantitySelectorButton |\n| quantitySelectorDecrease |\n| quantitySelectorIncrease |\n| removeButtonContainer |\n| item |\n| removeButton |\n| unitPriceContainer |\n| unitListPrice |\n| unitPriceMeasurementUnit |\n| unitPricePerUnitCurrency |\n\n[Product Identifier« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-identifier)[Product PriceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-price)\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-list/docs/apps/vtex.product-list%23configuration)\n\n[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23advanced-configuration)[minicart-product-list props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23minicart-product-list-props)[product-list props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23product-list-props)[message props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23message-props)[price props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23price-props)[unit-price props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23unit-price-props)[product-list-image props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23product-list-image-props)[product-reference props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23product-reference-props)[remove-button props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23remove-button-props)[quantity-selector props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23quantity-selector-props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%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_0af5d5f8
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore molecules card in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-overview)\n\nCard\n\nDisplays products, messages, or store information.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Card)\n\nA basic card that divides the content into a header and body, making it ideal for showcasing products, messages, or any other store information.\n\nExample\n\nCode\n\nCard with Icon\n\n# Message \n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Card } from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/molecules/Card/styles.scss\"; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Examples\n\nExample\n\nCode\n\nCard with Icon\n\n# First Product \n\n---\n\n# Second Product \n\nExample\n\nCode\n\nCard without Icon\n\n# Message \n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ----------------------------- | --------------------------------- |\n| \\--fs-card-border-radius | var(--fs-border-radius) |\n| \\--fs-card-border-width | var(--fs-border-width) |\n| \\--fs-card-border-color | var(--fs-border-color-light) |\n| \\--fs-card-header-padding | var(--fs-spacing-3) |\n| \\--fs-card-header-bkg-color | var(--fs-color-neutral-bkg) |\n| \\--fs-card-header-font-weight | var(--fs-text-weight-bold) |\n| \\--fs-card-header-icon-color | var(--fs-color-main-2) |\n| \\--fs-card-body-padding | var(--fs-spacing-3) |\n\n---\n\n## Data attributes\n\nYou can target and override `Card` styles using the following data attributes:\n\n* `data-fs-card`\n* `data-fs-card-header`\n* `data-fs-card-title`\n* `data-fs-card-body`\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| -------------- | ---------- | -------------------------------------------------------------------------------------- | ------- |\n| **title\\*** | string | Specifies the text to be loaded into the header. | |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-card |\n| **maxWidth** | string | Specifies the card max width. | |\n| **iconName** | string | Specifies what icon to use following the FastStore Icon sheet. | |\n| **iconAction** | () => void | Function that should be executed when the icon is clicked | |\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/components/molecules/card.mdx)\n\n[BuyButton« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-buy-button)[CarouselNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-carousel)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23examples)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23props)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/card.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23examples)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-card/docs/guides/faststore/molecules-card%23props)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_760c8c44
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides add customer profile information to the cart in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\nAdding customer profile information to the cart\n\nThe shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThis guide will describe how to add customer profile information to the shopping cart via API.\n\n## Getting shopping cart information\n\nThe first step is to get the `orderFormId` of the shopping cart to which you want to add the customer preferences information. For more information, read the [Getting cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id) guide.\n\n## Adding customer profile information to the shopping cart\n\nTo add customer profile information to the shopping cart, use the [Add client profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/attachments/clientProfileData) endpoint. In this request, you must send the `orderFormId` through the URL address, as shown in the example below:\n\n`https://{accountName}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/attachments/clientProfileData`\n\nAdditionally, you need to send the request body containing the following customer information:\n\n* **Required**: \n * `email`: Customer email address. \n * `firstName`: Customer first name. \n * `lastName`: Customer last name. \n * `documentType`: Type of document provided by the customer (e.g., CPF in Brazil, SSN in the U.S.). \n * `document`: Document number provided by the customer.\n* **Recommended (optional)**: \n * `phone`: Customer phone number.\n* **If the client is a legal entity**: \n * `corporateName`: Company name. \n * `tradeName`: Trade name. \n * `corporateDocument`: Corporate document. \n * `stateInscription`: State document number. \n * `corporatePhone`: Business phone number. \n * `isCorporate`: `True`.\n\nAfter sending the request, the endpoint will return the response body containing the client information in the shopping cart, as in the example below:\n\n`1\n\n... \n\n2\n\n\"clientProfileData\": { \n\n3\n\n \"email\": \"customer@examplemail.com\", \n\n4\n\n \"firstName\": \"first-name\", \n\n5\n\n \"lastName\": \"last-name\", \n\n6\n\n \"document\": \"123456789\", \n\n7\n\n \"documentType\": \"cpf\", \n\n8\n\n \"phone\": \"+55110988887777\", \n\n9\n\n \"corporateName\": \"company-name\", \n\n10\n\n \"tradeName\": \"trade-name\", \n\n11\n\n \"corporateDocument\": \"12345678000100\", \n\n12\n\n \"stateInscription\": \"12345678\", \n\n13\n\n \"corporatePhone\": \"+551100988887777\", \n\n14\n\n \"isCorporate\": false, \n\n15\n\n \"profileCompleteOnLoading\": false, \n\n16\n\n \"profileErrorOnLoading\": false, \n\n17\n\n \"customerClass\": null \n\n18\n\n } \n\n19\n\n... \n\n`\n\n> ️ For more information on each field available in the shopping cart, see the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 400 - Bad Request\n\n* **Message error example (code ORD002)**: `\"Invalid order form\"`. The `orderFormId` information is not valid.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD002\", \n\n5\n\n \"message\": \"Invalid order form\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"5d9f54e6-7db4-46d6-bca9-deeb278b8b98\" \n\n9\n\n} \n\n`\n\n* **Message error example (code ORD007)**: `\"The email field in the customer profile attachment is invalid\"`: This message indicates that the `email` used in the request does not exist or is incorrect.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD007\", \n\n5\n\n \"message\": \"The email field in the customer profile attachment is invalid\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"37fcbaf6-9245-46b2-8735-f5fb304d1ac2\" \n\n9\n\n} \n\n`\n\n### 404 - Not Found\n\n* **Message error example**: `\"The requested URL was not found on the server\"`: Check if the URL is correct.\n\n`1\n\n<body> \n\n2\n\n <h1>404 Not Found</h1> \n\n3\n\n <p>The requested URL was not found on this server.</p> \n\n4\n\n</body> \n\n`\n\nContributors\n\n1\n\n[](https://github.com/GeorgeLimaDev)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/cart-attachments-section-quick-start-guides/add-customer-profile-information-to-the-cart.md)\n\n[Getting a customer profile by email« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart//docs/guides/getting-a-customer-profile-by-email)[Add shipping address and select delivery optionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart//docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\nContributors\n\n1\n\n[](https://github.com/GeorgeLimaDev)\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding customer profile information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart%23adding-customer-profile-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart%23404-not-found)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/cart-attachments-section-quick-start-guides/add-customer-profile-information-to-the-cart.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding customer profile information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart%23adding-customer-profile-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-profile-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart%23404-not-found)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0a227bb4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides ads 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/ads-events/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-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/ads-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/ads-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/ads-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/ads-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/ads-events/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/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/ads-events/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/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/ads-events/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/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/ads-events/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/ads-events)\n\n[Understanding ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/understanding-ads-events)\n\n[Ads events notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/ads-events-notification)\n\n[Impressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/impressions)\n\n[Views](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/views)\n\n[Clicks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/clicks)\n\n[Conversion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/conversion)\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/ads-events/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/ads-events/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/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/ads-events/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/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/ads-events/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/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/ads-events/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/ads-events)\n\n[Understanding ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/understanding-ads-events)\n\n[Ads events notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/ads-events-notification)\n\n[Impressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/impressions)\n\n[Views](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/views)\n\n[Clicks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/clicks)\n\n[Conversion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/conversion)\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/ads-events/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/ads-events/docs/guides)\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/getting-started-with-vtex-ads-api)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events/docs/guides/ads-events)\n\nAds events\n\nOverview of event types and how they’re used for campaign analytics.\n\nTo accurately track campaign performance and apply the appropriate billing model — whether based on clicks (CPC), impressions (CPM), or conversions (CPA) — you must notify VTEX Ads whenever a relevant ad event occurs.\n\nThe following event types are required for effective reporting:\n\n* **Impressions**: When an ad is rendered on the screen.\n* **View**: When a banner ad is visibly seen by the user (banner ads only).\n* **Clicks**: When a user clicks on an ad.\n* **Conversions**: When a user completes a defined conversion action after interacting with an ad.\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/ads-events.md)\n\n[Digital Signage« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events//docs/guides/digital-signage)[Understanding ads eventsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ads-events//docs/guides/understanding-ads-events)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/ads-events.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_e1ba3752
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides node builder 7x migration 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/node-builder-7x-migration-guide/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-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/node-builder-7x-migration-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/node-builder-7x-migration-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/node-builder-7x-migration-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/node-builder-7x-migration-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/node-builder-7x-migration-guide/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/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/node-builder-7x-migration-guide/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/app-development-guides)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide)\n\nNode builder 7.x migration guide\n\nLearn how to update your Node app to builder version 7.x.\n\nWith the [Node builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder) update to version `7.x`, IO apps using this builder benefit from the Node.js 20 engine and TypeScript 5.x libraries, improving performance and security. However, this also means these apps need to be adjusted for the latest features.\n\nCheck the demo video below showing how to migrate your app to Node builder `7.x`.\n\n## Instructions\n\nTo update your app to use the new builder version, follow the instructions below:\n\n1. Update the VTEX IO CLI to version `4.1.0` or newer. \n 1. In a terminal, run `vtex -v` to check your VTEX IO CLI version. If you do not have VTEX IO CLI installed, you can find the instructions in [Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install). \n 2. If your version is older than `4.1.0`, run `vtex autoupdate` to update your VTEX IO CLI.\n2. Make sure `node/package.json` has the `typescript` property in `devDependencies`. 3\\. In your app folder, open the `node/package.json` file. 4\\. In the `devDependencies` property, check if the `typescript` package is declared. If it is not, add it with version `5.x`. It should look like this: \nnode/package.json \n`1 \n\"devDependencies\": { \n2 \n ... \n3 \n \"typescript\": \"5.x\" \n4 \n}, \n` \n> If the app already has `typescript` declared in `devDependencies`, you don’t need to change its version manually. When linking the app, the package version is overwritten automatically.\n3. Update the `manifest.json` with `node 7.x`. \n 1. In your app folder, open the `manifest.json` file. \n 2. Change the `node` builder version to `7.x`. It should look like this: \n manifest.json \n `1 \n \"builders\": { \n 2 \n ... \n 3 \n \"node\": \"7.x\" \n 4 \n }, \n `\n4. Test the app. \n 1. Open a terminal in the root folder of your app. \n 2. Make sure you are in a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace). You can create a new one or switch to an existing one. \n 3. Run `vtex link`. You will notice that the `node/package.json` will be updated with the new versions of `typescript` (`5.5.3`) and `@node/types` (`20.x`). \n 4. Check errors and fix them if they appear. Your app might not be fully compatible with the newer TypeScript and Node.js engine versions, and syntax, typing, or dependency errors might occur. See the [Troubleshooting](#heading=h.2w3bbhmrvkih) section for instructions about the most common errors.\n5. Create and deploy a new app version following the steps in [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 1. In the [Release a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version) step, we recommend creating a **minor** version since this update is not exclusively fixing issues as in a **patch**, and a **major** version would require additional work. \n > For apps in the [App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store), creating a new **major** version will require the app to go through the [homologation process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23step-2-managing-the-homologation-process). \n 2. Follow the other steps (Publish, Test, Deploy, and Promote) as needed. Some apps are used only on one account, while others should deploy the new version to multiple accounts.\n\nIf you need help migrating your app to Node builder `7.x`, open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n## Troubleshooting\n\nWhen migrating your app to the new builder version, some issues might occur. The following sections show the most common issues and what can be done to solve them.\n\n### Typing errors\n\nWhen linking your app, you might get an error in the following format:\n\n`Argument of type <type>| undefined' is not assignable to a parameter of type '<type>'.`\n\nThis means that the argument is being declared as a certain type and is recognized as `undefined`.\n\n**Solution**: You must ensure the argument is not `undefined`, or update the [field type to be optional](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/2/everyday-types.html%23optional-properties).\n\n### \"yarn lint\" at the project root\n\nErrors may occur in the following scenario:\n\n1. There’s a lint configuration at the root of the project. It should be in files such as `.eslintrc` and `.eslintignore`.\n2. The `package.json` file in the root is configured with an old version of TypeScript. For instance, the file has TypeScript version `3.9.6`, but Node builder `7.x` uses `5.5.3`.\n3. Something used in the code (a class, a library, etc.) doesn’t exist in the old TypeScript version.\n\n**Solution**: Update the TypeScript version in the root `package.json`. We recommend using version `5.5.3`, since it’s used in Node builder `7.x`.\n\n**Side effect**: If the app uses the `eslint-config-vtex` package, you will get a warning in the console about version incompatibility.\n\n### Alerts related to different TypeScript versions\n\nWhen linking your app, you might get errors like the following examples:\n\n* `@vtex/tsconfig@0.6.0\" has incorrect peer dependency \"typescript@^`\n* `eslint-config-vtex@10.1.0\" has incorrect peer dependency \"typescript@^3.3.3333\"`\n\nThese alerts may appear because some of the app's dependencies may run with an old TypeScript version.\n\n> Errors in this scenario might be due to some VTEX libraries not being updated with TypeScript `5.x`. They should be updated gradually over time.\n\n**Solution**: Update the `package.json` files of the dependencies manually with the new TypeScript version. We recommend using version `5.5.3`, since it’s the same used in Node builder `7.x`.\n\n### Error with MetricsAggregator\n\nIf you’re accessing `global.metrics` in your code, defined by the `node-vtex-api` library, you should get the error:\n\n`Property 'metrics' does not exist on type 'typeof globalThis'.`\n\nThis happens because of a breaking change between versions `12.x` and `20.x` of `@types/node`.\n\n**Solution:** Use `global` as `any`, replacing `global` with `(global as any)` in your code. Example: `(global as any).metrics`.\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/back-end-development-guides/node-builder-7x-migration-guide.md)\n\n[Developing service configuration apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide//docs/guides/vtex-io-documentation-developing-service-configuration-apps)[GraphQL in VTEX IONext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide//docs/guides/graphql-in-vtex-io)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23instructions)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23troubleshooting)\n\n[Typing errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23typing-errors)[\"yarn lint\" at the project root](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23yarn-lint-at-the-project-root)[Alerts related to different TypeScript versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23alerts-related-to-different-typescript-versions)[Error with MetricsAggregator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23error-with-metricsaggregator)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/back-end-development-guides/node-builder-7x-migration-guide.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/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23instructions)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23troubleshooting)\n\n[Typing errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23typing-errors)[\"yarn lint\" at the project root](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23yarn-lint-at-the-project-root)[Alerts related to different TypeScript versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23alerts-related-to-different-typescript-versions)[Error with MetricsAggregator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide/docs/guides/node-builder-7x-migration-guide%23error-with-metricsaggregator)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4421f2f0
|
[
{
"role": "system",
"content": "You are a VTEX 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 making a custom component available in site editor in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-working-with-site-editor)\n\n[Integrating a frontend app with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\n\n[Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\n[Site Editor schema examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-working-with-site-editor)\n\n[Integrating a frontend app with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\n\n[Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\n[Site Editor schema examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/store-framework-working-with-site-editor)\n\n[Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\nMaking a custom component available in Site Editor\n\nLearn how to allow component customization directly in Site Editor.\n\nTo allow component customization in [Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor), you need to define the schema for each editable property and reference these definitions in the `interfaces.json` file.\n\nIn this guide, you will learn how to configure the schema definitions in your components, allowing users to customize them directly in Site Editor.\n\n> Explore practical examples of using schemas to configure custom components in [Site Editor schema examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples).\n\n## Before you begin\n\n* Ensure your store has a [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) developed with [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) and [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework), following the [Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) guide.\n* Check if the [Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) are properly installed in your Store Theme. You must have at least the following builders configured: \n * [Store builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder): Enables the development of Store Framework storefronts. \n * [React builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder): Used to develop apps with [React](https://read.calvincode.net/reader?url=https://react.dev/) when your project requires customized frontend solutions.\n\n## Instructions\n\n### Step 1 - Creating the files for your custom component\n\nFor your block to accept user customizations, export the React component responsible for the block. This component should include a schema that allows editing directly in Site Editor.\n\n1. Create a new folder in the `/react` root directory. Follow the `react/components/{ComponentName}/index.tsx` pattern. See alongside a folder structure example for a component named `CustomComponent`.\n2. Open the `index.tsx` file and define your custom component.\n\n### Step 2 - Defining the component interface\n\nThe `CustomComponentProps` defines the type for the component’s props, specifying `title` and `subtitle` as the expected string props.\n\n### Step 3 - Declaring the component\n\nThe functional component `CustomComponent` takes an object with `title` and `subtitle` props as its argument, allowing easy access to these props.\n\n### Step 4 - Defining the component props\n\nThe `defaultProps` specifies the default values for the props of the `CustomComponent`. If the user does not define props in Site Editor, the `defaultProps` values are returned.\n\n### Step 5 - Configuring the Site Editor schema\n\nThe `schema` defines the structure and types of the props, allowing the component to be customized in Site Editor.\n\n> Ensure you define the `defaultProps` and `schema` objects for the component in [JSON Schema](https://read.calvincode.net/reader?url=https://json-schema.org/) format, a declarative language that provides a standardized way to describe and validate JSON data.\n\n### Step 6 - Exporting the component\n\nBy setting `CustomComponent` as the default export, you can import it into other parts of the app or other apps. For better organization and management, especially for apps with many custom components, we recommend creating separate folders for each component within `react/components` and then exporting them from individual files in the `/react` root directory.\n\nIn the `/react` root directory, create a new file to export your component:\n\n### Step 7 - Updating the `interfaces.json` file\n\nNow, you need to reference your custom component in the [interfaces.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface) within the `/store` folder. This file establishes the relationship 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's frontend.\n\nIn the app repository where you are developing your custom component, open the `interfaces.json` file within the `/store` folder. Declare the schema definitions for your component as follows:\n\n> In this schema, the block identifier is named `custom-component`. Choose a name that clearly describes the component it references.\n\n### Step 8 - Using the component in a store page\n\nTo use the new component, declare it in the desired page template. For example, to use the `CustomComponent` on the store’s main page, the `custom-component` block must be declared within the `home` block:\n\nBy [linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app), your component will be available for visualization and test in Site Editor within the corresponding [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace).\n\n### Step 9 - Making your component available in the live store’s Site Editor\n\nAfter configuring and testing your component, deploy the new version of your app to make it available in the live store’s Site Editor.\n\nLearn how to make it available in the [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) guide.\n\nWhen the process is finished, the component will appear as follows in the live account’s Site Editor:\n\n\n\n`1\n\n react \n\n2\n\n ┣ 📂 components \n\n3\n\n ┣ 📂 CustomComponent \n\n4\n\n ┗ 📄 index.tsx \n\n`\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-making-a-custom-component-available-in-site-editor.mdx)\n\n[Integrating a frontend app with Site Editor« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor//docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)[Site Editor schema examplesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor//docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\nSee also\n\n[Storefront appsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)[Site Editor schema examplesGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23instructions)\n\n[Step 1 - Creating the files for your custom component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-1-creating-the-files-for-your-custom-component)[Step 2 - Defining the component interface](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-2-defining-the-component-interface)[Step 3 - Declaring the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-3-declaring-the-component)[Step 4 - Defining the component props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-4-defining-the-component-props)[Step 5 - Configuring the Site Editor schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-5-configuring-the-site-editor-schema)[Step 6 - Exporting the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-6-exporting-the-component)[Step 7 - Updating the interfaces.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-7-updating-the-interfacesjson-file)[Step 8 - Using the component in a store page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-8-using-the-component-in-a-store-page)[Step 9 - Making your component available in the live store’s Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-9-making-your-component-available-in-the-live-stores-site-editor)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-making-a-custom-component-available-in-site-editor.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/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23instructions)\n\n[Step 1 - Creating the files for your custom component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-1-creating-the-files-for-your-custom-component)[Step 2 - Defining the component interface](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-2-defining-the-component-interface)[Step 3 - Declaring the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-3-declaring-the-component)[Step 4 - Defining the component props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-4-defining-the-component-props)[Step 5 - Configuring the Site Editor schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-5-configuring-the-site-editor-schema)[Step 6 - Exporting the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-6-exporting-the-component)[Step 7 - Updating the interfaces.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-7-updating-the-interfacesjson-file)[Step 8 - Using the component in a store page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-8-using-the-component-in-a-store-page)[Step 9 - Making your component available in the live store’s Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor%23step-9-making-your-component-available-in-the-live-stores-site-editor)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_9e9d158b
|
[
{
"role": "system",
"content": "You are a VTEX 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 v2 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/master-data-v2-guides/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-v2-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/master-data-v2-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/master-data-v2-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/master-data-v2-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/master-data-v2-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/master-data-v2-guides/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/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-v2-guides/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-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/master-data-v2-guides/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/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-v2-guides/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/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-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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-v2-guides/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-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/master-data-v2-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/master-data-v2-guides/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/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-v2-guides/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-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/master-data-v2-guides/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/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-v2-guides/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/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-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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/master-data-v2-guides/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-v2-guides/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-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/master-data-v2-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/master-data-v2-guides/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/docs/guides/master-data)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides/docs/guides/master-data-v2)\n\nv2 Guides\n\nThis section contains tutorials about Master Data v2\\. Here you will find the following articles:\n\n* [Using Master Data v2 triggers to interact with orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders)\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)\n* [Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2)\n* [Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2)\n* [Using dynamic expressions in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2)\n* [Search by geocoordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-by-geo-coordinates)\n* [Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-document-saving-flow)\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/master-data-v2.md)\n\n[Avoiding CORS in Master Data requests« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides//docs/guides/avoiding-cors-in-master-data-requests)[Schema LifecycleNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v2-guides//docs/guides/master-data-schema-lifecycle)\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/master-data-v2.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_f9519f20
|
[
{
"role": "system",
"content": "You are a VTEX 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 recipe in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-recipe/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-recipe/docs/api-reference)\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-recipe/docs/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-recipe/docs/storefront-development)\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-recipe/docs/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-recipe/docs/troubleshooting)\n\n[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-recipe/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-recipe/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-recipe/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-recipe/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-recipe/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/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-recipe/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-recipe/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-recipe/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/search-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/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-recipe/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/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-recipe/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-recipe/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-recipe/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-recipe/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/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-recipe/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-recipe/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-recipe/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/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-recipe/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-recipe/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-recipe/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/search-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/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-recipe/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/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-recipe/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-recipe/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-recipe/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-recipe/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-recipe/docs/guides)\n\nIntegration Guides\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/search-integration-guide)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-recipe)\n\nImplementing a Custom Search Resolver App\n\nSupposing you want to integrate another search provider into VTEX, here are the steps you should follow to create an app that follows the VTEX Search Protocol:\n\n1. Clone the VTEX Intelligent Search search resolver app: <https://github.com/vtex-apps/search-resolver/tree/v1.x>.\n2. **TEMPORARY:** Uninstall any other search-resolver app that may be installed on the account you're using (`e.g: vtex.search-resolver@0.x`). You may need to do this in a separate workspace if the store is live\n3. Change the `vendor` field on the app's `manifest.json` to map the account you're using.\n4. Start changing the queries' resolvers implementations to retrieve and return the data from the external search engine you're integrating.\n\n## Client\n\nIn VTEX IO, we have the concept of clients to abstract calling other services in a centralized class. If you've cloned the search resolver listed above, you will see that it grabs data by using the following client: <https://github.com/vtex-apps/search-resolver/blob/v1.x/node/clients/biggy-search.ts>. Change the implementation of this client to fetch data from the search provider that you want to integrate with.\n\n## Resolvers\n\nThe main resolver file that you need to change is this <https://github.com/vtex-apps/search-resolver/blob/v1.x/node/resolvers/search/index.ts>. You can look for occurrences of `biggySearch` and change the data treatment to get the wanted behavior. Remember that you may want to leave some resolvers untouched and continue grabbing data from VTEX Catalog's APIs.\n\n### Tips on Working with the Example\n\n* Entries and files with `BiggySearchClient` should be modified and renamed accordingly to the search engine to be integrated.\n* The main file to look at is `node/resolvers/search/index.ts`, where is implemented resolvers for search-related queries. It's important to notice that some resolvers **will not be modified** since they're connecting directly to VTEX APIs. This will be addressed on future releases of VTEX Search Protocol. You can find a list of all the queries to change the implementation in the specification section of this document.\n* It's important to adapt the Typescript types into the code, because they're specific to VTEX Search.\n\n## Troubleshooting\n\nIn case of any \"Unknown errors\", check if the version on `node/package.json` for the dependency `vtex.search-graphql` is up to date with the [latest version for the vtex.search-graphql app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-graphql/blob/master/manifest.json%23L4). After changing the version on the URL, you need to run `yarn` inside the **node** folder before running `vtex link` again.\n\n[Back](search-integration-guide)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/search-integration-guide/external-search-provider-recipe.md)\n\n[Specification« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe//docs/guides/external-search-provider-specification)[Reference ImplementationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe//docs/guides/external-search-provider-reference)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-recipe%23client)\n\n[Resolvers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-recipe%23resolvers)\n\n[Tips on Working with the Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-recipe%23tips-on-working-with-the-example)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-recipe%23troubleshooting)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/search-integration-guide/external-search-provider-recipe.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-recipe%23client)\n\n[Resolvers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-recipe%23resolvers)\n\n[Tips on Working with the Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-recipe%23tips-on-working-with-the-example)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe/docs/guides/external-search-provider-recipe%23troubleshooting)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_2ce7c4ac
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX google drive import 0.x app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/vtex-io-apps)\n\nGoogle Drive Import\n\nOfficial extension\n\nVersion: 0.6.1\n\nLatest version: 0.6.1\n\n> The specified version of the app (**0.x.0**) does not exist. This page is about the latest stable version, which is **0.6.1**.\n\nThis app allows SKU images to be bulk imported into the VTEX Catalog from a user's Google Drive._**Note**_ _Importing images supported by version 1 catalogs only._\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-installing-an-app) `vtex.google-drive-import` in the desired account.\n2. In your account's admin dashboard, go to `Catalog > Google Drive Import`.\n3. Follow the instructions provided on the admin page to grant access to your Google Drive and upload your images with the proper naming convention.\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x/docs/apps/vtex.google-drive-import@0.x%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_96fe413c
|
[
{
"role": "system",
"content": "You are a VTEX 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 merchant id in apple pay in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/docs/api-reference)\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-merchant-id-in-apple-pay/docs/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-merchant-id-in-apple-pay/docs/storefront-development)\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-merchant-id-in-apple-pay/docs/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-merchant-id-in-apple-pay/docs/troubleshooting)\n\n[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-merchant-id-in-apple-pay/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/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/setting-up-merchant-id-in-apple-pay/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/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-merchant-id-in-apple-pay/docs/guides)\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/guides/payments-configuration-guides)\n\n[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/guides/setting-up-merchant-id-in-apple-pay)\n\nSetting up Merchant ID in Apple Pay\n\nIn order for your store to begin receiving payments with **Apple Pay**, you will need to set **Merchant ID** in your [Apple developer account](https://read.calvincode.net/reader?url=https://developer.apple.com/).\n\n## Creating the Merchant ID\n\nFirst of all, you need to create the Merchant ID itself - your store's ID on Apple's system.\n\nThis account acts as your login to the Apple Pay setup with VTEX. More specifically, this Merchant ID will be entered in the gateway affiliation which will, in turn, process payments.\n\nIt's therefore important to choose an ID that's easy to remember. We recommend something similar to `merchant.yourStoreName.vtexpayments.com.br.apple`.\n\nIn addition, your Merchant ID will not be the same as that of other stores. Apple's system ensures that each ID is unique.\n\nLet's now turn our attention to the step-by-step process below:\n\n1. Access your Apple **developer account** at `https://developer.apple.com/account/#/overview/`.\n2. Select the **Certificates, IDs & Profiles** option.\n\n\n\n1. Select **Identifiers**.\n\n\n\n1. Next to Identifiers, click on the blue **+** button.\n\n\n\n1. Select the **Merchant IDs** option.\n2. Click on the blue **Continue** button.\n\n\n\n1. Fill on the **Description** field.\n2. Fill in the **Identifier** field.\n3. Click on **Continue**.\n\n\n\nYou will have created your **Merchant ID**.\n\n## Creating the certificate to process payments\n\nNow you've created your Merchant ID, you'll need a certificate to activate it.\n\nThis certificate is created by VTEX. Therefore, the retailer needs to [open a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/open-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) with support for the team responsible for integrations to send you the file.\n\nThereafter, the retailer can submit the file to Apple Pay's system.\n\nFollow the instructions below to proceed to this step:\n\n1. On the left-hand side, open **Certificates** from the menu.\n\n\n\n1. Type in your newly created **Merchant ID** in the search bar.\n2. Select the desired **Merchant ID**.\n\n\n\n1. Under **Apple Pay Payment Processing Certificate**, click the **Create Certificate** button.\n\n\n\n1. Ensure that the question _\"Will payments associated with this Merchant ID be processed exclusively in China?\"_ is ticked with the **default option (No)**.\n\n\n\nYou'll then be redirected to a screen with instructions on creating the Certificate Signing Request (CSR).\n\nThis is the time to open a ticket with the certificate request. The VTEX team will send you a file entitled `{{merchantID}}.csr` and with it saved on your computer, you must click on **Continue**.\n\nAfter this step, you will be redirected once again, this time to the upload screen.\n\nWith the `{{merchantID}}.csr` that you've received, complete the following:\n\n1. Click on **Choose File**.\n2. Select the desired **CSR file**.\n3. Click on **Continue**.\n\n\n\n1. Click on **Download**.\n\n\n\n1. Click on **Done**.\n\n## Adding domains to Merchant ID\n\nThe next step is to link the domains used by your store to the Merchant ID that you've just created.\n\nFirstly, you need to validate each of the desired URLs. Once this step is correctly completed, Apple's own system will create a `.txt` file and point to which domain this document should be linked to.\n\nLastly, you need to import this file to VTEX's system through Postman - an [API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis) management tool.\n\n> This validation can only be done one domain at a time. This means that if your store uses 10 different domains, the process will have to be repeated 10 times.\n\nFollow these steps:\n\n1. Search for the recently created **MerchantID** in the search bar.\n\n\n\n1. Click on the desired **MerchantID**.\n2. In the **Merchant Domain** module, click on **Add Domain**.\n\n\n\n1. Add the domain in the **Enter the domain you wish to register** field.\n2. Click on **Save**.\n\nThereafter, to upload the`.txt` file by API, follow these instructions:\n\n1. Click on **Download** and make no changes to the file.\n\n\n\n1. Open the `.txt` file and **copy** all the content.\n\nThen, start a Postman session. You perform a call to VTEX's CDN using the POST method:\n\n1. Configure the route **POST** `https://{{yourdomainhere}}/.well-known/raw/apple-developer-merchantid-domain-association.txt`.\n2. Paste the content of the .txt file in the request body. Ensure that all contents of the file are: \n * Inside quotations marks. \n * In JSON format, as in `\"{token_content}\"`. \n * Without any line breaks.\n\n\n\n1. Add the **X-VTEX-API-AppKey** and the **X-VTEX-API-AppToken** to the header.\n\nNow, when making the **POST** call, the response will inform you that your certificate will be saved for 60 minutes. During this time, you should complete the domain validation.\n\nHead back to the Apple's website. On the same screen where you downloaded the `.txt` file, click on **Verify**.\n\n\n\nIf you've followed the step-by-step correctly, your domain will be registered with the **verified** status. If you want, you can repeat the process to add more domains by using the **Add Domain** button in the **Merchant Domains** section.\n\n## Creating a Merchant Identity Certificate\n\nLastly, you must generate a Merchant ID certificate, which will be used every time Apple shows the Apple Pay screen to your customers. To complete the steps of this process, it's important that to have a Mac computer available.\n\nTo complete the action, you'll need to create a password to protect the exported data.\n\n> ️ We recommend an easy to remember password, since it will be filled into the Apple Merchant Password field upon configuring the gateway affiliation on VTEX's platform.\n\n1. Access the **Certificate**, **Identifiers & Profilers** module.\n2. From the left side menu, choose **Identifiers**.\n3. In the upper right corner, filter by **Merchant IDs**.\n\n\n\n1. Select the desired **Merchant Identifier**.\n2. Click on **Create Certificate**.\n\n\n\n1. Follow the **instructions** displayed on the screen to create a certificate.\n2. Click on **Continue**.\n\n\n\n1. Click on **Download**.\n\n\n\nAfter the file has been downloaded, double-click it to install it in Keychain Access. \n\nAfterwards, proceed to the following steps:\n\n1. Open **Keychain Access**.\n2. Locate the **certificate** created in step 4 above.\n3. Right click on the **key** icon.\n\n\n\n1. Click on **Export**.\n2. Give the **certificate** a name.\n3. Select the **.p12** export format.\n4. Click on **OK**.\n5. Save the certificate on your computer.\n\nAfter completing all the steps above, you will have a Merchant ID set up for Apple Pay, a `.p12` certificate saved on your computer, and an access password. All this data will be requested during the process of setting up the [payment provider](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/registering-gateway-affiliations--tutorials%5F444) that will process payments with Apple Pay in your store.\n\nContributors\n\n4\n\n[](https://github.com/ricardoaerobr)\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/Payments/payments-configuration-guides/setting-up-merchant-id-in-apple-pay.md)\n\n[Setting up the type of interest rate« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay//docs/guides/setting-up-the-type-of-interest-rate)[Cardholder document configurationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay//docs/guides/cardholder-document-configuration)\n\nContributors\n\n4\n\n[](https://github.com/ricardoaerobr)\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[Creating the Merchant ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/guides/setting-up-merchant-id-in-apple-pay%23creating-the-merchant-id)\n\n[Creating the certificate to process payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/guides/setting-up-merchant-id-in-apple-pay%23creating-the-certificate-to-process-payments)\n\n[Adding domains to Merchant ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/guides/setting-up-merchant-id-in-apple-pay%23adding-domains-to-merchant-id)\n\n[Creating a Merchant Identity Certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/guides/setting-up-merchant-id-in-apple-pay%23creating-a-merchant-identity-certificate)\n\nWas this helpful?\n\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/setting-up-merchant-id-in-apple-pay.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Creating the Merchant ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/guides/setting-up-merchant-id-in-apple-pay%23creating-the-merchant-id)\n\n[Creating the certificate to process payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/guides/setting-up-merchant-id-in-apple-pay%23creating-the-certificate-to-process-payments)\n\n[Adding domains to Merchant ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/guides/setting-up-merchant-id-in-apple-pay%23adding-domains-to-merchant-id)\n\n[Creating a Merchant Identity Certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay/docs/guides/setting-up-merchant-id-in-apple-pay%23creating-a-merchant-identity-certificate)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e06c22dd
|
[
{
"role": "system",
"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 affirm payment 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.affirm-payment/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/api-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.affirm-payment/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.affirm-payment/docs/storefront-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.affirm-payment/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.affirm-payment/docs/troubleshooting)\n\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.affirm-payment/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/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.affirm-payment/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.affirm-payment/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.affirm-payment/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.affirm-payment/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.affirm-payment/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.affirm-payment/docs/vtex-io-apps)\n\nAffirm Payment\n\nOfficial extension\n\nVersion: 2.3.0\n\nLatest version: 2.3.0\n\nThis is a payment authorization app for the Affirm payment method (financing with monthly payments). By installing this app, the [Affirm payment connector app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/affirm-api) will also be automatically installed as a dependency.\n\n> _Currently Affirm cannot be used in a marketplace scenario where the seller account processes the payment. In marketplace scenarios, the marketplace account must process the payment._\n\n## Configuration\n\n1. [Install this app](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/installing-an-app/) in your account by running `vtex install vtex.affirm-payment`.\n2. Enable Affirm as a payment method in your store admin. In the Gateway Affiliation, enter your Affirm public API key as the `Application Key` and your Affirm private API key as the `Application Token`. For initial testing, set the Test/Production toggle to `Test` and use sandbox keys.\n3. Configure the app settings by clicking `Apps > My Apps` in your account's admin sidebar and then selecting `Affirm Payment`.\n\nThe available settings are:\n\n* `Enable Katapult`: Katapult is a newer Affirm feature that offers a leasing option to shoppers who do not qualify for the normal Affirm financing. Please ask your Affirm contact to enable the feature on your Affirm account before enabling this app setting.\n* `Company Name`: If you have multiple sites operating under a single Affirm account, you can override the external company/brand name that the customer sees. This affects all references to your company name in the Affirm UI. Leave blank to use your default company name stored in your Affirm account.\n* `Public API Key for promotional components`: The public API key provided to you by Affirm.\n* `Production Mode for promotional components`: Determines if the components from the [Affirm Components](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/affirm-components) app run in Production or Sandbox mode.\n* `Interval to use for the following three settings`: Determines the unit of time used by the following settings.\n* `Delay to automatic payment capture`: Number of minutes/hours/days before authorized Affirm payments are automatically settled.\n* `Delay to automatic payment capture after antifraud analysis`: Number of minutes/hours/days before authorized Affirm payments are automatically settled after merchant's antifraud approval.\n* `Delay to cancel`: Number of minutes/hours/days before Affirm payments are automatically canceled. \n> _`Delay to cancel` also affects the amount of time the user is given to complete the Affirm checkout modal. As such, the app will enforce a minimum `delay to cancel` time of 60 minutes. Shorter times may be inputted on the settings page, but they will be ignored. Also, times longer than 1 day should not be used._\n* `Katapult public token`: The public API token for your Katapult account. This is only needed if Katapult is enabled.\n* `Katapult private token`: The private API token for your Katapult account. This is only needed if Katapult is enabled.\n* `Partial cancellation`: Feature flag to enable partial cancellation feature, which when enabled, ensures that the amount for partially canceled items on order is voided during settlement.\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.affirm-payment/docs/apps/vtex.affirm-payment%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_a1fd1e56
|
[
{
"role": "system",
"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 masterdata 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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-api/docs/api-reference/masterdata-api/)\n\nAttachments\n\nClusters\n\nData Entities\n\nDocuments\n\nCustomer profiles\n\nAddresses\n\nScore\n\nScroll\n\nSearch\n\nVersions\n\nContracts\n\nContact information\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-api/docs/api-reference/masterdata-api/)\n\nAttachments\n\nClusters\n\nData Entities\n\nDocuments\n\nCustomer profiles\n\nAddresses\n\nScore\n\nScroll\n\nSearch\n\nVersions\n\nContracts\n\nContact information\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-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/masterdata-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeSearch shopper document by user ID« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/docs/api-reference/master-data-api-v2%23get-/api/dataentities/shopper/search)[GeRetrieve attachmentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/documents/-id-/-field-/attachments/-file-name-)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_1ac6a603
|
[
{
"role": "system",
"content": "You are a VTEX 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_71fbb492
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting my store translation is not behaving as expected in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/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/my-store-translation-is-not-behaving-as-expected/docs/troubleshooting)\n\nStore performance\n\nMy store translation is not behaving as expected\n\nMy store is being translated when it shouldn't.\n\n**Keywords:** Translation\n\nThis issue is related to the store's default locale. If store translation is not behaving as expected, follow the instructions below.\n\n1. Access the API `GET http://portal.vtexcommercestable.com.br/api/tenant/tenants?q={accountName}` and check the `defaultLocale` property.\n\n> Replace the `{accountName}` with your VTEX account name.\n\n1. If the `defaultLocale` value doesn't match your store locale, [open a support ticket](https://read.calvincode.net/reader?url=https://support.vtex.com/hc/en-us/requests) to report the issue.\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/store-performance/my-store-translation-is-not-behaving-as-expected.md)\n\n[My store is presenting price inconsistencies« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/troubleshooting/my-store-is-presenting-price-inconsistencies)[Activity Flow: Monitoring Headless stores and mobile appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected/docs/troubleshooting/2025-12-11-activity-flow-monitoring-headless-stores-and-mobile-apps)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\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/my-store-translation-is-not-behaving-as-expected.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_ea36d07e
|
[
{
"role": "system",
"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 oauth provider admin 2.x 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.oauth-provider-admin@2.x/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/api-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.oauth-provider-admin@2.x/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.oauth-provider-admin@2.x/docs/storefront-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.oauth-provider-admin@2.x/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.oauth-provider-admin@2.x/docs/troubleshooting)\n\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.oauth-provider-admin@2.x/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/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.oauth-provider-admin@2.x/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.oauth-provider-admin@2.x/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/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.oauth-provider-admin@2.x/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.oauth-provider-admin@2.x/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.oauth-provider-admin@2.x/docs/vtex-io-apps)\n\nVTEX OAuth Provider\n\nOfficial extension\n\nVersion: 2.3.1\n\nLatest version: 2.3.1\n\n> The specified version of the app (**2.x.0**) does not exist. This page is about the latest stable version, which is **2.3.1**.\n\nUse VTEX authentication as an IdP for your applications using the well-known OAuth2 protocol (<https://tools.ietf.org/html/rfc6749>). You can choose between **admin** or **store** credentials, allowing other systems to use the VTEX login validation. This will not provide access to VTEX resources, only verify the user authentication.\n\nThe allowed flows so far are:\n\n* Authentication Code (<https://tools.ietf.org/html/rfc6749#section-1.3.1>)\n\n**\\[IMPORTANT\\] As Authentication Code is the only flow implemented, for security reasons the client must have a server side application that will exchange the code for a token (Access Token Request), using the private client secret as authentication method.**\n\nThe account must have the app `vtex.oauth-provider-admin` installed. It'll add \"OAuth Provider\" in \"Account Settings\".\n\nAn account can have many OAuth clients registered, with different settings:\n\n* **Name**: readable identifier \\[IT IS NOT THE CLIENT ID\\]\n* **Allowed URI's** : a list of URI\\`s that can be used as return uri in the flow\n* **Credential Type**: the type of VTEX authentication that will be used to login: _admin_ or _store_ \n * **Admin**: uses default VTEX login page \n * **Store**: allows the account to set a custom login page url, which must have a VTEX ID login flow\n\nAfter the registration, the client will be issued a **Client Id** and a **Client Secret**.\n\n## How to use\n\nThe application that want to use VTEX as an IdP using OAuth2 can implement the Authentication Code flow (<https://tools.ietf.org/html/rfc6749#section-4.1>), using the following endpoints:\n\n### Authorization request\n\n`[GET] https://{{account}}.myvtex.com/_v/oauth2/auth?client_id={{client_id}}&scope=&response_type=code&redirect_uri={{redirect_uri}}` (<https://tools.ietf.org/html/rfc6749#section-4.1.1>)\n\n* client\\_id: the Client Id issued after the client registration \\[REQUIRED\\]\n* redirect\\_uri: the encoded URL that the authorization server will redirect the user-agent, with _code_ and _state_ as query string \\[OPTIONAL\\]\n* scope: TBD \\[IGNORED\\]\n* response\\_type: type of the authentication flow. Must be **code** \\[REQUIRED\\]\n* state: An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client \\[RECOMMENDED\\]\n\n### Authorization response\n\nIf the resource owner grants the access request, the authorization server issues an authorization code and delivers it to the client by adding the following parameters to the query component of the redirection URI (<https://tools.ietf.org/html/rfc6749#section-4.1.2>)\n\n* code: the authorization code generated by the authorization server\n* state: the same \"state\" parameter received in the client authorization request\n\n### Access Token request\n\n`[POST] https://{{account}}.myvtex.com/\\_v/oauth2/token` (<https://tools.ietf.org/html/rfc6749#section-4.1.3>). Send the following parameters using the \"application/x-www-form-urlencoded\" format in the HTTP request entity-body:\n\n* grant\\_type: value MUST be set to \"authorization\\_code\" \\[REQUIRED\\]\n* code: the authorization code received from the authorization server \\[REQUIRED\\]\n* redirect\\_uri: \\[REQUIRED\\], if the \"redirect\\_uri\" parameter was included in the authorization request and their values MUST be identical.\n* client\\_id: issued client\\_id \\[REQUIRED\\]\n* client\\_secret: issued client\\_secret \\[REQUIRED\\]\n\n### Access Token response\n\nThe authorization server issues an access token as below:\n\n`1\n\n{ \n\n2\n\n \"access_token\": {access_token}, \n\n3\n\n \"token_type\": \"bearer\" \n\n4\n\n} \n\n`\n\n## OAuth2 extension\n\nThe Introspect endpoint is a commmon extension to the OAuth2 framework that provides some information about the issued token, like _username_ and _user\\_id_.\n\n### Introspect request\n\n`[GET] https://{{account}}.myvtex.com/oauth2/introspect?token={{access_token}}`\n\n* access\\_token: the token received from /token endpoint.\n\n### Introspect response\n\nA json with the following token properties:\n\n* active: if the token still active\n* scope: the scopes allowed to this token\n* client\\_id: the client\\_id of the token\n* username: the username used in the authentication\n* user\\_id: the user\\_id from the user in the authentication\n* exp: expiration date of the token\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 use](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/apps/vtex.oauth-provider-admin@2.x%23how-to-use)\n\n[Authorization request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/apps/vtex.oauth-provider-admin@2.x%23authorization-request)[Authorization response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/apps/vtex.oauth-provider-admin@2.x%23authorization-response)[Access Token request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/apps/vtex.oauth-provider-admin@2.x%23access-token-request)[Access Token response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/apps/vtex.oauth-provider-admin@2.x%23access-token-response)\n\n[OAuth2 extension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/apps/vtex.oauth-provider-admin@2.x%23oauth2-extension)\n\n[Introspect request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/apps/vtex.oauth-provider-admin@2.x%23introspect-request)[Introspect response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x/docs/apps/vtex.oauth-provider-admin@2.x%23introspect-response)\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_d8c35383
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides searching by geocoordinates 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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-in-master-data-v2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-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/searching-by-geocoordinates-in-master-data-v2/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-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/searching-by-geocoordinates-in-master-data-v2/docs/guides/master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\nSearching by geocoordinates in Master Data v2\n\nTo enable search by geocoordinates in Master Data v2, your JSON schema must contain an object with the properties `latitude` and `longitude`:\n\n`1\n\n{ \n\n2\n\n\"properties\": { \n\n3\n\n \"{{yourFieldName}}\": { \n\n4\n\n \"type\": \"object\", \n\n5\n\n \"properties\": { \n\n6\n\n \"latitude\": { \"type\": \"number\" }, \n\n7\n\n \"longitude\": { \"type\": \"number\" } \n\n8\n\n }, \n\n9\n\n \"additionalProperties\": false \n\n10\n\n } \n\n11\n\n } \n\n12\n\n} \n\n`\n\nAlso, it must be configured as indexed:\n\n`1\n\n{ \n\n2\n\n \"v-indexed\": [ \"{{yourFieldName}}\" ] \n\n3\n\n} \n\n`\n\n## Saving documents\n\nTo save a document that can later be searched by geocoordinates, it must contain the object value configured as geocoordinates:\n\n`1\n\n{ \n\n2\n\n \"{{yourFieldName}}\": { \n\n3\n\n \"latitude\": {{value}}, \n\n4\n\n \"longitude\": {{value}} \n\n5\n\n } \n\n6\n\n} \n\n`\n\n## Filtering\n\nTo filter documents that contain a location nearby a given geocoordinate (measured in km), add a filter as a query parameter in this format:\n\n`1\n\n{{yourFieldName}}={{latitudeValue}},{{longitudeValue}},{{integer}}km \n\n`\n\nSee an example:\n\n`1\n\naddress.location=-23.01227,-43.46163,25km \n\n`\n\n## Ordering search results by distance\n\nTo order documents by distance from a given geocoordinate, use the `_sort` query parameter with this format:\n\n`1\n\n _sort={{yourFieldName}} {{asc/desc}} {{latitudeValue}},{{longitudeValue}} km \n\n`\n\nSee an example\n\n`1\n\n _sort=address.location asc -23.01227,-43.46163 km \n\n`\n\nWhen Master Data order results by distance from a geocoordinate field a new field is available: `_sort`. This field could be added in `_fields` parameter to retrieve the distance between the geocoordinate in the sort query.\n\n## Real complete example\n\nJSON Schema:\n\n`1\n\n { \n\n2\n\n \"properties\": { \n\n3\n\n \"name\": { \n\n4\n\n \"type\": \"string\" \n\n5\n\n }, \n\n6\n\n \"isActive\": { \n\n7\n\n \"type\": \"boolean\" \n\n8\n\n }, \n\n9\n\n \"address\": { \n\n10\n\n \"type\": \"object\", \n\n11\n\n \"properties\": { \n\n12\n\n \"state\": { \n\n13\n\n \"type\": \"string\" \n\n14\n\n }, \n\n15\n\n \"location\": { \n\n16\n\n \"type\": [ \n\n17\n\n \"null\", \n\n18\n\n \"object\" \n\n19\n\n ], \n\n20\n\n \"properties\": { \n\n21\n\n \"latitude\": { \n\n22\n\n \"type\": \"number\" \n\n23\n\n }, \n\n24\n\n \"longitude\": { \n\n25\n\n \"type\": \"number\" \n\n26\n\n } \n\n27\n\n }, \n\n28\n\n \"additionalProperties\": false \n\n29\n\n } \n\n30\n\n } \n\n31\n\n } \n\n32\n\n }, \n\n33\n\n \"v-indexed\": [ \n\n34\n\n \"name\", \n\n35\n\n \"isActive\", \n\n36\n\n \"address\" \n\n37\n\n ], \n\n38\n\n \"v-default-fields\": [ \n\n39\n\n \"id\", \n\n40\n\n \"name\", \n\n41\n\n \"address\", \n\n42\n\n \"_sort\" \n\n43\n\n ] \n\n44\n\n } \n\n`\n\nQuery:\n\n`1\n\n /search?address.location=-23.01227,-43.46163,100km&_schema=v1&_sort=address.location asc -23.01227,-43.46163 km&_fields=id,_sort \n\n`\n\nResult:\n\n`1\n\n [ \n\n2\n\n { \n\n3\n\n \"id\": \"AME\", \n\n4\n\n \"_sort\": [ \n\n5\n\n 0 \n\n6\n\n ] \n\n7\n\n }, \n\n8\n\n { \n\n9\n\n \"id\": \"BAR\", \n\n10\n\n \"_sort\": [ \n\n11\n\n 10.71936198115181 \n\n12\n\n ] \n\n13\n\n }, \n\n14\n\n { \n\n15\n\n \"id\": \"BAN\", \n\n16\n\n \"_sort\": [ \n\n17\n\n 14.87184710662879 \n\n18\n\n ] \n\n19\n\n }, \n\n20\n\n { \n\n21\n\n \"id\": \"BRX\", \n\n22\n\n \"_sort\": [ \n\n23\n\n 27.607623540300178 \n\n24\n\n ] \n\n25\n\n } \n\n26\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/searching-by-geocoordinates-in-master-data-v2.md)\n\n[Using dynamic expressions on Master Data v2« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2//docs/guides/using-dynamic-expressions-on-master-data-v2)[Setting up alternate keys in Master Data v2Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2//docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Saving documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2%23saving-documents)\n\n[Filtering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2%23filtering)\n\n[Ordering search results by distance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2%23ordering-search-results-by-distance)\n\n[Real complete example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2%23real-complete-example)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/searching-by-geocoordinates-in-master-data-v2.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Saving documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2%23saving-documents)\n\n[Filtering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2%23filtering)\n\n[Ordering search results by distance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2%23ordering-search-results-by-distance)\n\n[Real complete example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/searching-by-geocoordinates-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2%23real-complete-example)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e2a3cfd6
|
[
{
"role": "system",
"content": "You are a VTEX 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 4 configuringtemplates in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-4-configuringtemplates/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-4-configuringtemplates/docs/api-reference)\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-4-configuringtemplates/docs/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-4-configuringtemplates/docs/storefront-development)\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-4-configuringtemplates/docs/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-4-configuringtemplates/docs/troubleshooting)\n\n[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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/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-4-configuringtemplates/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/store-framework)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/getting-started-3)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n4\\. Configuring templates\n\nLearn how to manage templates and customize your Store Theme.\n\nIn this guide, you'll learn how to customize your store theme by managing templates that define the structure of your website pages. Templates declare `JSON` blocks that, once rendered, determine the set of components for your website pages, such as the homepage, product page, search results page, etc.\n\nThe [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) app already implements basic templates for each page of your store, defined within its `blocks.json` or `blocks.jsonc` files. These templates enable your store to display VTEX Store Framework default components, even if you haven’t made any custom configurations in the code. By managing templates, you can create a custom theme for your website by adding or removing blocks to meet your business needs.\n\n## Before you begin\n\n### Learn about the JSON block concept\n\nFamiliarize yourself with the concept of a `JSON` block - the smallest Store Framework abstraction of React components displayed on the user interface. Thus, blocks are self-contained pieces of code, exported to the platform by independent apps, that determine how components are rendered on your website.\n\nBlocks are imbued with higher flexibility, allowing you to achieve complex scenarios and specific component behaviors by configuring their properties (_props_) or even declaring them in other blocks. In practice, when you edit your theme's code using the Store Theme app, you're directly modifying blocks that will become your store's page components when rendered.\n\n> To add a new component to a page, you simply declare a new block in the corresponding template. Similarly, removing a block from a template will exclude its associated component from the page.\n\n### Get to know the property (prop) concept\n\nTo manage your templates efficiently, be familiar with the concept of `properties` (_prop_), which define the performance and visual identity of the component rendered in the interface. The more props a block has, the more flexible its configuration becomes for the end user.\n\nEvery JSON is defined using `{ }`, with keys and values that together specify its properties, representing its inherent characteristics. See the example below:\n\n`1\n\n{ \n\n2\n\n \"name\": \"Pedro\", \n\n3\n\n \"height\": 1.90 \n\n4\n\n} \n\n`\n\nIn the example above, `name` and `height` are the object's keys, and their respective values are `Pedro` and `1.90`.\n\nThe `key + value` pair constitutes the property (or _prop_) of the JSON, defining its essential characteristics.\n\n> The key and value can also be called, respectively, property name and property value.\n\n### Understand the block composition\n\nWhen a block is being developed, the composition definition indicates how the block’s content is structured or how it interacts with other components. There are 3 types of composition definitions:\n\n* `blocks`: Have a fixed position on the store’s page irrespective of where they were declared in the code, leading to a preordained position on the UI.\n* `children`: Do not have a fixed position on the store’s page, which means that how they’re declared in the code directly impacts the page position. The `children` block declared first will be at the top of the page, followed by the second one below it, and so on.\n* `slots`: Placeholders within a block that enable the insertion of dynamic content. It is useful for flexible component design where content can be passed into specific slots, enabling the customization or reuse of a block with different content.\n\nAccording to their composition, the listed blocks will determine whether they should be declared in the parent block's `blocks` list or in its `children` list when building a single component on the UI.\n\n> You can find out which composition a block has by looking at its code in the exporting app's `interfaces.json` file.\n\n## Instructions\n\n### Step 1 - Declaring blocks in your Store Theme app\n\nDeclare all your blocks in the `blocks.jsonc` file, or create as many files and folders as needed within the `store` folder to organize store blocks and templates. You can also declare blocks in the `blocks` subfolder. The only difference is that `jsonc` files allow you to add comments to the code.\n\nSince blocks are pieces of code exported by VTEX Store Framework apps, whenever a block is used in your theme, the app behind it must be declared in your Store Theme [dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-dependencies/) list.\n\nThe `dependencies` object within the `manifest.json` file of your Store Theme app specifies the names and versions of various apps. These apps are pre-listed, as the default Store Theme code already defines templates that use blocks exported by them.\n\nWhen declaring a new block in your Store Theme app, check if the app blocking it is listed as a dependency. If not, open the `manifest.json` file and add the app name and desired version to the `dependencies` list, following this format: `\"vtex.{appName}\": \"{majorVersion}.x\"`.\n\n> Replace the values between the curly braces based on your scenario.\n\n### Step 2 - Managing blocks in your theme\n\nTo better understand how to manage blocks within your Store Theme app, follow the steps below to see the structure of the predefined homepage template:\n\n1. Open the Store Theme app using the code editor of your choice.\n2. Go to `store` and then `blocks`.\n3. Access `home` and then `home.jsonc`. You'll see a result similar to the following:\n\n`` 1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"list-context.image-list#demo\", \n\n5\n\n /* You can make references to blocks defined in other files. \n\n6\n\n * For example, `flex-layout.row#deals` is defined in the `deals.json` file. */ \n\n7\n\n \"flex-layout.row#deals\", \n\n8\n\n \"rich-text#shelf-title\", \n\n9\n\n \"flex-layout.row#shelf\", \n\n10\n\n \"info-card#home\", \n\n11\n\n \"rich-text#question\", \n\n12\n\n \"rich-text#link\", \n\n13\n\n \"newsletter\" \n\n14\n\n ] \n\n15\n\n }, \n\n16\n\n \n17\n\n \"shelf#home\": { \n\n18\n\n \"blocks\": [\"product-summary.shelf\"] \n\n19\n\n }, \n\n20\n\n \n21\n\n \"product-summary.shelf\": { \n\n22\n\n \"children\": [ \n\n23\n\n \"product-summary-name\", \n\n24\n\n \"product-summary-description\", \n\n25\n\n \"product-summary-image\", \n\n26\n\n \"product-summary-price\", \n\n27\n\n \"product-summary-sku-selector\", \n\n28\n\n \"product-summary-buy-button\" \n\n29\n\n ] \n\n30\n\n }, \n\n31\n\n \n32\n\n \"list-context.image-list#demo\": { \n\n33\n\n \"children\": [\"slider-layout#demo-images\"], \n\n34\n\n \"props\": { \n\n35\n\n \"height\": 720, \n\n36\n\n \"images\": [ \n\n37\n\n { \n\n38\n\n \"image\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal.png\", \n\n39\n\n \"mobileImage\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal-mobile.jpg\" \n\n40\n\n }, \n\n41\n\n { \n\n42\n\n \"image\": \"https://storecomponents.vteximg.com.br/arquivos/banner.jpg\", \n\n43\n\n \"mobileImage\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal-mobile.jpg\" \n\n44\n\n } \n\n45\n\n ] \n\n46\n\n } \n\n47\n\n }, \n\n48\n\n \"slider-layout#demo-images\": { \n\n49\n\n \"props\": { \n\n50\n\n \"itemsPerPage\": { \n\n51\n\n \"desktop\": 1, \n\n52\n\n \"tablet\": 1, \n\n53\n\n \"phone\": 1 \n\n54\n\n }, \n\n55\n\n \"infinite\": true, \n\n56\n\n \"showNavigationArrows\": \"desktopOnly\", \n\n57\n\n \"blockClass\": \"carousel\" \n\n58\n\n } \n\n59\n\n }, \n\n60\n\n \n61\n\n \"rich-text#shelf-title\": { \n\n62\n\n \"props\": { \n\n63\n\n \"text\": \"## Summer\", \n\n64\n\n \"blockClass\": \"shelfTitle\" \n\n65\n\n } \n\n66\n\n }, \n\n67\n\n \"flex-layout.row#shelf\": { \n\n68\n\n \"children\": [\"list-context.product-list#demo1\"] \n\n69\n\n }, \n\n70\n\n \"list-context.product-list#demo1\": { \n\n71\n\n \"blocks\": [\"product-summary.shelf\"], \n\n72\n\n \"children\": [\"slider-layout#demo-products\"], \n\n73\n\n \"props\": { \n\n74\n\n \"orderBy\": \"OrderByTopSaleDESC\" \n\n75\n\n } \n\n76\n\n }, \n\n77\n\n \"slider-layout#demo-products\": { \n\n78\n\n \"props\": { \n\n79\n\n \"itemsPerPage\": { \n\n80\n\n \"desktop\": 5, \n\n81\n\n \"tablet\": 3, \n\n82\n\n \"phone\": 1 \n\n83\n\n }, \n\n84\n\n \"infinite\": true, \n\n85\n\n \"fullWidth\": true, \n\n86\n\n \"blockClass\": \"shelf\" \n\n87\n\n } \n\n88\n\n }, \n\n89\n\n \n90\n\n \"info-card#home\": { \n\n91\n\n \"props\": { \n\n92\n\n \"id\": \"info-card-home\", \n\n93\n\n \"isFullModeStyle\": false, \n\n94\n\n \"textPosition\": \"left\", \n\n95\n\n \"imageUrl\": \"https://storecomponents.vteximg.com.br/arquivos/banner-infocard2.png\", \n\n96\n\n \"headline\": \"Clearance Sale\", \n\n97\n\n \"callToActionText\": \"DISCOVER\", \n\n98\n\n \"callToActionUrl\": \"/sale/d\", \n\n99\n\n \"blockClass\": \"info-card-home\", \n\n100\n\n \"textAlignment\": \"center\" \n\n101\n\n } \n\n102\n\n }, \n\n103\n\n \n104\n\n \"rich-text#question\": { \n\n105\n\n \"props\": { \n\n106\n\n \"text\": \"**This is an example store built using the VTEX platform.\\nWant to know more?**\", \n\n107\n\n \"blockClass\": \"question\" \n\n108\n\n } \n\n109\n\n }, \n\n110\n\n \n111\n\n \"rich-text#link\": { \n\n112\n\n \"props\": { \n\n113\n\n \"text\": \"\\n**Reach us at**\\nwww.vtex.com.br\", \n\n114\n\n \"blockClass\": \"link\" \n\n115\n\n } \n\n116\n\n }, \n\n117\n\n \n118\n\n \"product-summary-buy-button\": { \n\n119\n\n \"props\": { \n\n120\n\n \"displayBuyButton\": \"displayButtonAlways\" \n\n121\n\n } \n\n122\n\n } \n\n123\n\n} \n\n ``\n\nAs you can see above, the default `store.home` homepage template declares the following blocks:\n\n* `list-context.image-list#demo`\n* `flex-layout.row#deals`\n* `rich-text#shelf-title`\n* `flex-layout.row#shelf`\n* `info-card#home`\n* `rich-text#question`\n* `rich-text#link`\n* `newsletter`\n\nThis means that your default store homepage will comprise the components defined by these blocks.\n\nTo build more complex components, the `home.jsonc` file includes each block’s declaration and configuration, using the block's props and, if necessary, other blocks.\n\n> More than simply declaring a block in the block list template, you must also define its behavior when rendered as a component. To do this, use the block's props, as shown in the [Clarifying block naming and properties](#step-3-clarifying-block-naming-and-properties) section, and include other child blocks to configure it, as detailed in [Defining blocks composition](#step-4-defining-blocks-composition).\n\n### Step 3 - Clarifying block naming and properties\n\nStill in the `home.jsonc` file, use `ctrl+f` and search for the `rich-text#question` block. This block renders a component that displays markdown text to users.\n\n`1\n\n\"rich-text#question\": { \n\n2\n\n \"props\": { \n\n3\n\n \"text\": \"**This is an example store built using the VTEX platform. Want to know more?**\", \n\n4\n\n \"blockClass\": \"question\" \n\n5\n\n } \n\n6\n\n}, \n\n`\n\nThe `rich-text#question` block has two props: `text` and `blockClass`. The `text` prop specifies the content the component will display, while `blockClass` defines an ID used for customization.\n\nTo check the available props of the app behind the `rich-text` block, see the Configuration section within the [Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text) app documentation. Note that the exported block's name is simply `rich-text`, whereas Store Theme uses `rich-text#block`. This is because you can use a `#` symbol after the block's official name to easily identify it when inserting it into the theme's code and better organize the theme.\n\n> All the props available to configure a block can be found in the documentation of its exporting app or in the block's own documentation (if applicable).\n\n### Step 4 - Defining blocks composition\n\nStill in the `home.jsonc`, search for the`shelf#home` block.\n\n`1\n\n\"shelf#home\": { \n\n2\n\n \"blocks\": [\"product-summary.shelf\"] \n\n3\n\n}, \n\n`\n\nNote that it declares another block to your `blocks` list, which in turn declares other blocks below in a list called `children`:\n\n`1\n\n\"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-name\", \n\n4\n\n \"product-summary-description\", \n\n5\n\n \"product-summary-image\", \n\n6\n\n \"product-summary-price\", \n\n7\n\n \"product-summary-sku-selector\", \n\n8\n\n \"product-summary-buy-button\" \n\n9\n\n ] \n\n10\n\n}, \n\n`\n\nIn the example above, `product-summary.shelf` requires other blocks as children, such as `product-summary-name`, to render the component properly.\n\n> As previously mentioned, a component can be a crossroad for multiple blocks. Therefore, one of your theme blocks may need to list other blocks to achieve the desired rendering on the UI.\n\nTo build a component using multiple blocks, the main block can declare a `blocks` list, such as `shelf#home`, or a `children` list, as seen in the `product-summary.shelf` block.\n\nAs explained in [Understand the block composition](#understand-the-block-composition), the choice between using a `blocks` or `children` list depends on the _composition_ of the blocks being declared.\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-4-configuringtemplates.md)\n\n[3\\. Creating a Store Theme project« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates//docs/guides/vtex-io-documentation-3-settingyourstoretheme)[5\\. Defining stylesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates//docs/guides/vtex-io-documentation-5-definingstyles)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23before-you-begin)\n\n[Learn about the JSON block concept](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23learn-about-the-json-block-concept)[Get to know the property (prop) concept](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23get-to-know-the-property-prop-concept)[Understand the block composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23understand-the-block-composition)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23instructions)\n\n[Step 1 - Declaring blocks in your Store Theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23step-1-declaring-blocks-in-your-store-theme-app)[Step 2 - Managing blocks in your theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23step-2-managing-blocks-in-your-theme)[Step 3 - Clarifying block naming and properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23step-3-clarifying-block-naming-and-properties)[Step 4 - Defining blocks composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23step-4-defining-blocks-composition)\n\nWas this helpful?\n\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-4-configuringtemplates.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-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23before-you-begin)\n\n[Learn about the JSON block concept](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23learn-about-the-json-block-concept)[Get to know the property (prop) concept](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23get-to-know-the-property-prop-concept)[Understand the block composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23understand-the-block-composition)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23instructions)\n\n[Step 1 - Declaring blocks in your Store Theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23step-1-declaring-blocks-in-your-store-theme-app)[Step 2 - Managing blocks in your theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23step-2-managing-blocks-in-your-theme)[Step 3 - Clarifying block naming and properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23step-3-clarifying-block-naming-and-properties)[Step 4 - Defining blocks composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates/docs/guides/vtex-io-documentation-4-configuringtemplates%23step-4-defining-blocks-composition)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_9432fc29
|
[
{
"role": "system",
"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 media 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-media/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-media/docs/api-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-media/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-media/docs/storefront-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-media/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-media/docs/troubleshooting)\n\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-media/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-media/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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.store-media/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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.store-media/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.store-media/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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.store-media/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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.store-media/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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-media/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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-media/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-media/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-media/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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-media/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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.store-media/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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.store-media/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.store-media/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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.store-media/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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.store-media/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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-media/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/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-media/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-media/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-media/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/guides/advanced-components)\n\nMedia\n\nOfficial extension\n\nVersion: 0.3.0\n\nLatest version: 0.3.0\n\n[](#contributors-)\n\nThe Media app allows you to display image and video assets using a single block.\n\n\n\n## Configuration\n\n1. Add the `store-media` app to your theme's dependencies in the `manifest.json` file:\n\n`1\n\n \"dependencies \": { \n\n2\n\n+ \"vtex.store-media\": \"0.x\" \n\n3\n\n } \n\n`\n\nNow, you are able to use all blocks exported by the `store-media` app. Check out the full list below:\n\n| Block name | Description |\n| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| media | This block is capable of displaying a single image or video. |\n| list-context.media-list | This block allows you to display a list of images and videos in your store with a higher degree of composability. You can use it along with other list-context or slider-layout blocks to create different sliders and layouts. |\n\n### `media` block\n\nThe `media` block inherits all props from `image` and `video` blocks. It's highly recommended you check out the docs for [Image](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-image) and [Video](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-video) blocks before using this block.\n\nYou can use props from both blocks, but `media` will only consider the props from the block (`image` or `video`) that matches the current `mediaType`, or, in the case of `mediaType` being `imageOrVideo`, that matches the type of the `src`.\n\n| Prop name | Type | Description | Default value |\n| --------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| mediaType | enum | Type of the media to be displayed. Possible values are: image (behaves as an image block no matter the src), video (behaves as an video block no matter the src), and imageOrVideo. Choosing imageOrVideo will make media automatically identify the type of the src based on its extension and behave accordingly. | imageOrVideo |\n\nUse the **admin's Site Editor** to manage some props declared in the `media` block. Using the Site Editor to provide the image or video `src` will force you to choose between `image` and `video`.\n\n**Usage Example**:\n\n`1\n\n\"media#mobile-phone\": { \n\n2\n\n \"props\": { \n\n3\n\n \"src\": \"https://storecomponents.vteximg.com.br/arquivos/mobile-phone.png\", \n\n4\n\n \"blockClass\": \"storePrint\" \n\n5\n\n } \n\n6\n\n} \n\n`\n\n### `list-context.media-list` block\n\nThe `list-context.media-list` block acts just like the `list-context.image-list` block and inherits a lot from `image` and `video` blocks, with a few key differences. It's highly recommended you check out the docs for [Image](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-image) and [Video](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-video) blocks before using this block.\n\n`list-context.media-list` accepts both images and videos, so you can mix them inside a single carousel, for example. Images can receive `image` blocks' props and videos can receive `video` blocks' props. If you pass props that don't match the media type, they will be ignored.\n\n| Prop name | Type | Description | Default value |\n| --------- | -------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |\n| height | \\`string | number\\` | This value is used for the max-height CSS property and **is applied to images only**. |\n| mediaList | \\[MediaListElement\\] | List of MediaListElement that represents the media to be added to the list context. | \\[\\] |\n\n* `MediaListElement` object\n\nA `MediaListElement` object has a very similar shape to the props accepted by the `media` component, that is, you can specify the `mediaType` of the asset you want to display and pass the props for `image` and `video` blocks. Read the docs for the `media` block to better understand how that works.\n\nDifferently from the `media` component, it does **not** use the `src` prop to receive the assets. For images, it uses the `image` and `mobileImage` props, and, for video, it uses the `video` and `mobileVideo` props.\n\n| Prop name | Type | Description | Default value |\n| ----------- | ------ | ----------------------------------------------------------------------------------------------------------------------- | ------------- |\n| image | string | URL to the image to be displayed. | undefined |\n| mobileImage | string | URL to the image to be displayed when the user is using a mobile device. If it's undefined, image will be used instead. | undefined |\n| video | string | URL to the video to be displayed. | undefined |\n| mobileVideo | string | URL to the video to be displayed when the user is using a mobile device. If it's undefined, video will be used instead. | undefined |\n\n**Usage Example**:\n\n`1\n\n\"list-context.media-list#demo\": { \n\n2\n\n \"children\": [\"slider-layout#demo-media\"], \n\n3\n\n \"props\": { \n\n4\n\n \"height\": 720, \n\n5\n\n \"mediaList\": [ \n\n6\n\n { \n\n7\n\n \"image\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal.png\", \n\n8\n\n \"mobileImage\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal-mobile.jpg\" \n\n9\n\n }, \n\n10\n\n { \n\n11\n\n \"video\": \"https://www.youtube.com/embed/JgkrlaF52WQ\" \n\n12\n\n }, \n\n13\n\n { \n\n14\n\n \"image\": \"https://storecomponents.vteximg.com.br/arquivos/banner.jpg\", \n\n15\n\n \"mobileImage\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal-mobile.jpg\" \n\n16\n\n } \n\n17\n\n ] \n\n18\n\n } \n\n19\n\n}, \n\n20\n\n\"slider-layout#demo-media\": { \n\n21\n\n \"props\": { \n\n22\n\n \"itemsPerPage\": 1, \n\n23\n\n \"infinite\": true, \n\n24\n\n \"showNavigationArrows\": \"desktopOnly\", \n\n25\n\n \"blockClass\": \"carousel\" \n\n26\n\n } \n\n27\n\n} \n\n`\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\nJust like they do with props, all blocks from this app inherits all of `image` and `video` blocks' CSS Handles. You can find them in their respective docs.\n\nKeep in mind that, for instance, applying CSS customizations to CSS Handles that came from `image` won't have any effect if the `mediaType` is set to `video` or if the `mediaType` is set to `imageOrVideo` and the `src` was identified as a video.\n\n[Store Link« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-link)[Store NewsletterNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-newsletter)\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.store-media/docs/apps/vtex.store-media%23configuration)\n\n[media block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-media%23media-block)[list-context.media-list block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-media%23list-contextmedia-list-block)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-media/docs/apps/vtex.store-media%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_9ef5a619
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore dynamic content consuming the dynamic content in custom 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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-overview)\n\n[Step 1 - Setting up the store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)\n\n[Step 2 - Handling Dynamic Content in custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-overview)\n\n[Step 1 - Setting up the store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)\n\n[Step 2 - Handling Dynamic Content in custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-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/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-overview)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-overview)\n\nStep 2 - Handling Dynamic Content in custom sections\n\nAfter [mapping pages and data-fetching functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23step-1-mapping-pages-and-data-fetching-functions) and choosing one of the methods for [creating Dynamic Content via API fetching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23step-2-creating-dynamic-content-via-api-fetching), use the data to render it in a store section. In this step, we will create a new Hero section, placed on a landing page, to render the image from the data.\n\n| _Before_: Using [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero) native section with an image uploaded from the Headless CMS. | _After:_ Using a custom Hero section fetching the image content from an API. |\n| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|  |  |\n\n## Before you begin\n\n* Complete the [Step 1 - Setting up your store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content) to set up your store code.\n* Make sure your store's Headless CMS includes the following sections in addition to your existing store page sections: \n * **Global**: Includes the global header and footer sections, which are required for all page types. \n * **Children**: Acts as the placeholder for the unique content of each page (including Landing Pages), and it is a mandatory section. Your local build will fail if this section is missing.\n\nFor more information, refer to [Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview%23sections).\n\n## Instructions\n\n### 1\\. Creating the section\n\nCreate and display a [section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) for the Dynamic Content. For this tutorial, we’ll create a [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero).\n\n1. Open your Faststore project.\n2. Inside `src`, create the folder `components`.\n3. Inside `components`, create a subfolder named `sections`.\n4. Inside `sections` create a file called `ProductHero.tsx`, and paste the following code: \nsrc/components/sections/ProductHero.tsx \n`1 \nimport { \n2 \n HeroSection, \n3 \n getOverriddenSection, \n4 \n useDynamicContent, \n5 \n} from \"@faststore/core\"; \n6 \nimport { ServerDynamicContentQuery } from \"@faststore/core/api\"; \n7 \n \n8 \nconst OverridenHero = getOverriddenSection({ \n9 \n Section: HeroSection, \n10 \n components: { \n11 \n HeroImage: { \n12 \n Component: CustomHeroImage, \n13 \n }, \n14 \n }, \n15 \n}); \n16 \n \n17 \nfunction CustomHeroImage() { \n18 \n const context = useDynamicContent<ServerDynamicContentQuery>(); \n19 \n \n20 \n return ( \n21 \n <img \n22 \n src={ \n23 \n context.data?.extraData?.customFieldFromRoot ?? \n24 \n \"https://via.placeholder.com/350\" \n25 \n } \n26 \n width={400} \n27 \n alt={context.data?.extraData?.customField ?? \"Hero section image\"} \n28 \n /> \n29 \n ); \n30 \n} \n31 \n \n32 \nexport default function ProductHero( \n33 \n props: React.ComponentProps<typeof OverridenHero> \n34 \n) { \n35 \n const context = useDynamicContent<ServerDynamicContentQuery>(); \n36 \n return ( \n37 \n <OverridenHero \n38 \n {...props} \n39 \n image={{ src: \"noop\", alt: \"noop\" }} \n40 \n title={ \n41 \n context.data?.extraData?.customField ?? \n42 \n \"Add the Hero section title here\" \n43 \n } \n44 \n /> \n45 \n ); \n46 \n} \n` \n * The `useDynamicContent` hook brings the data from the [@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package. \n * The `ServerDynamicContentQuery` specifies the type of data that we will get from the FastStore API package. \n * Since we are working with Hero, we import the Hero component and its styles. \n * The `useDynamicContent` hook holds the information in the `data` variable. \n * In return, we validate the data and display the image in the Hero and the product's name using some HTML elements.\n5. Create an `index.tsx` file inside the components folder and paste the following code: \n`1 \nimport ProductHero from “./sections/ProductHero” \n2 \n \n3 \nexport default { ProductHero }; \n`\n\nThis file helps import and export our new component. Now that the component is ready, let’s create its section schema for the Headless CMS.\n\n### 2\\. Synchronizing the component with Headless CMS\n\nTo define a schema for the `ProductHero` component within the Headless CMS, follow the steps below:\n\n1. Create the folders `cms/faststore` inside your project directory.\n2. Inside `faststore`, create the `sections.json` file.\n3. Paste the following code: \n`1 \n[ \n2 \n { \n3 \n \"name\": \"ProductHero\", \n4 \n \"schema\": { \n5 \n \"title\": \"Hero with a Fixed Image\", \n6 \n \"description\": \"Add a quick promotion with an image/action pair\", \n7 \n \"type\": \"object\", \n8 \n \"required\": [\"title\"], \n9 \n \"properties\": { \n10 \n \"title\": { \n11 \n \"title\": \"Title\", \n12 \n \"type\": \"string\" \n13 \n }, \n14 \n \"subtitle\": { \n15 \n \"title\": \"Subtitle\", \n16 \n \"type\": \"string\" \n17 \n }, \n18 \n \"link\": { \n19 \n \"title\": \"Call to Action\", \n20 \n \"type\": \"object\", \n21 \n \"properties\": { \n22 \n \"text\": { \n23 \n \"type\": \"string\", \n24 \n \"title\": \"Text\" \n25 \n }, \n26 \n \"url\": { \n27 \n \"type\": \"string\", \n28 \n \"title\": \"URL\" \n29 \n }, \n30 \n \"linkTargetBlank\": { \n31 \n \"type\": \"boolean\", \n32 \n \"title\": \"Open link in new window?\", \n33 \n \"default\": false \n34 \n } \n35 \n } \n36 \n }, \n37 \n \"colorVariant\": { \n38 \n \"type\": \"string\", \n39 \n \"title\": \"Color variant\", \n40 \n \"enumNames\": [\"Main\", \"Light\", \"Accent\"], \n41 \n \"enum\": [\"main\", \"light\", \"accent\"] \n42 \n }, \n43 \n \"variant\": { \n44 \n \"type\": \"string\", \n45 \n \"title\": \"Variant\", \n46 \n \"enumNames\": [\"Primary\", \"Secondary\"], \n47 \n \"enum\": [\"primary\", \"secondary\"] \n48 \n } \n49 \n } \n50 \n } \n51 \n } \n52 \n] \n`\n4. Run `yarn cms-sync` to synchronize the changes.\n5. Go to the VTEX Admin, and access **Storefront > Headless CMS**.\n6. Click `Create document` and choose `Landing Page` to create a new landing page.\n7. Add the new section.\n8. Open the **Settings** tab, and in the SEO path, add the slug for the new landing page, for example, `my-landing-page`. This step is essential because this slug is being consumed in the `index.tsx` file from the `dynamicContent` folder and this slug identifies in the code which content we want to bring to the page.\n9. Click `Save`.\n10. Open your terminal and run `yarn dev`. \n> Make sure you are logged in to your store account. If not run `vtex login {accountname}`.\n11. Open the localhost indicated in the terminal and add the `/my-landing-page` to the slug, e.g., `https://localhots:3000/my-landing-page`.\n12. Go to the localhost available and refresh the page. You will have the section similar to the following:\n\n\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/dynamic-content/step-2-handling-the-dynamic-content-in-custom-sections.mdx)\n\n[Step 1 - Setting up the store code for Dynamic Content« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)[Developer tools and referencesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/developer-tools-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23instructions)\n\n[1\\. Creating the section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%231-creating-the-section)[2\\. Synchronizing the component with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%232-synchronizing-the-component-with-headless-cms)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/dynamic-content/step-2-handling-the-dynamic-content-in-custom-sections.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23instructions)\n\n[1\\. Creating the section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%231-creating-the-section)[2\\. Synchronizing the component with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%232-synchronizing-the-component-with-headless-cms)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0b466637
|
[
{
"role": "system",
"content": "You are a VTEX 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 docs builder in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-manifest)\n\n[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-billing-options)\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-builders)\n\n[Admin Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-admin-builder)\n\n[Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-assets-builder)\n\n[Docs Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-docs-builder)\n\n[GraphQL Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-graphql-builder)\n\n[Messages Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-messages-builder)\n\n[Node Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-node-builder)\n\n[PaymentProvider Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-paymentprovider-builder)\n\n[Pixel Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-pixel-builder)\n\n[React Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-react-builder)\n\n[Store Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-store-builder)\n\n[Styles Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-styles-builder)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-dependencies)\n\n[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-peerdependencies)\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-manifest)\n\n[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-billing-options)\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-builders)\n\n[Admin Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-admin-builder)\n\n[Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-assets-builder)\n\n[Docs Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-docs-builder)\n\n[GraphQL Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-graphql-builder)\n\n[Messages Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-messages-builder)\n\n[Node Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-node-builder)\n\n[PaymentProvider Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-paymentprovider-builder)\n\n[Pixel Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-pixel-builder)\n\n[React Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-react-builder)\n\n[Store Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-store-builder)\n\n[Styles Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-styles-builder)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-dependencies)\n\n[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-peerdependencies)\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/app-development)\n\nProject structure\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-builders)\n\n[Docs Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-docs-builder)\n\nDocs builder\n\nLearn how to use the VTEX IO Docs builder.\n\nThe `docs` builder is used to publicly publish an app's documentation on the [VTEX Developer Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/), allowing users to access relevant information about your app. Once the app is [published](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app), all Markdown content within the `docs` folder becomes available in the VTEX Developer Portal.\n\nThe content will be available in a URL of the following format:\n\n`1\n\nhttps://developers.vtex.com/docs/apps/{appvendor}.{appname}@{appversion} \n\n`\n\nAny app developer can make their documentation publicly available using the docs builder. So even if your app is not published to the VTEX App Store, you can take advantage of this convenience.\n\n> When using the `docs` builder, ensure no sensitive or private information is shared in the files under the `/docs` folder.\n\n## Folder structure\n\nAn app that uses the `docs` builder has a folder named `/docs` in its root directory. This folder serves as the repository for the application's documentation, where all documentation files are written in [Markdown](https://read.calvincode.net/reader?url=https://www.markdownguide.org/basic-syntax/) format (\\*.md files).\n\nFollowing, you can find the basic app’s folder structure of an app using this builder:\n\n`1\n\ndocs \n\n2\n\n ┣ 📄 README.md \n\n`\n\nThe `README.md` is the main documentation file, where comprehensive information about the app is documented using Markdown syntax.\n\nIn addition to the README.md, developers can provide supplementary guides in separate Markdown files. For instance, an additional guide named `OptionalSteps.md` can be included to offer additional instructions or insights.\n\nEach documentation file, including the README.md and any supplementary guides, can be accessed via unique URLs within the VTEX Developer Portal. For example, the `README.md` is accessible at `https://developers.vtex.com/docs/apps/{appvendor}.{appname}@{appversion}`, while supplementary guides like `OptionalSteps.md` can be accessed at `https://developers.vtex.com/docs/apps/{appvendor}.{appname}@{appversion}/OptionalSteps`.\n\n## Usage\n\nTo begin using the `docs` builder in your app development, follow these steps.\n\n1. Add the `docs` builder to your app’s builder list in the `manifest.json` file, as the following:\n\n`1\n\n\"builders\": { \n\n2\n\n \"docs\": \"0.x\" \n\n3\n\n} \n\n`\n\n1. In the root directory of your app, create a `/docs` folder to manage your app’s documentation.\n2. [Publish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) and [deploy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version) your new app version.\n3. Once you publish your app, the documentation will be available in the VTEX Developer Portal.\n\n> **Versioning**: Each app version will have its own documentation available at `https://developers.vtex.com/docs/apps/{appvendor}.{appname}@{appversion}`, while accessing `https://developers.vtex.com/docs/apps/{appvendor}.{appname}` will direct users to the latest version.\n\n## Use case examples\n\nThe `docs` builder plays a crucial role in making an app’s documentation accessible. As a best practice, it is recommended that an app include at least the `README.md` file within the `/docs` folder.\n\nAs an example, check the [folder structure](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/locale-switcher/tree/master/docs) of this builder in the Locale Switcher app and its [public documentation in the Developer Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher).\n\nFor further guidance on structuring your app's documentation, refer to [Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines).\n\nContributors\n\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-builders/vtex-io-documentation-docs-builder.md)\n\n[Assets Builder« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder//docs/guides/vtex-io-documentation-assets-builder)[GraphQL BuilderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder//docs/guides/vtex-io-documentation-graphql-builder)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-docs-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-docs-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-docs-builder%23use-case-examples)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-builders/vtex-io-documentation-docs-builder.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-docs-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-docs-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder/docs/guides/vtex-io-documentation-docs-builder%23use-case-examples)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_3233770b
|
[
{
"role": "system",
"content": "You are a VTEX 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 ads in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/getting-started-with-vtex-ads-api)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/getting-started-with-vtex-ads-api)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides)\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/vtex-ads)\n\nVTEX Ads\n\nGet started with VTEX Ads by exploring how to integrate, sync, deliver, and track Retail Media campaigns across digital and physical channels.\n\nVTEX Ads is a Retail Media solution that allows brands, retailers, and agencies to create and manage ad campaigns directly within the VTEX ecosystem.\n\nFor developers, VTEX Ads provides the infrastructure and APIs to integrate ad placements across ecommerce storefronts, leverage campaign data, and customize ad rendering behavior.\n\n[Getting started with VTEX Ads APILearn how to integrate VTEX Ads into your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/getting-started-with-vtex-ads-api)[Synchronizing the Catalog with VTEX AdsSynchronize your product catalog with VTEX Ads to keep product information and inventory data up to date.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/synchronizing-the-catalog-with-vtex-ads)[Retrieving adsUnderstand how to retrieve and display sponsored ads tailored to search terms, categories, and customer behavior.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/retrieving-ads)[Ads eventsExplore how to collect and send user interaction data like impressions, views, and conversions to VTEX Ads.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads/docs/guides/understanding-ads-events)\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/vtex-ads.md)\n\n[Installing Activity Flow in React Native apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads//docs/guides/installing-activity-flow-in-react-native-apps)[Getting started with VTEX Ads APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads//docs/guides/getting-started-with-vtex-ads-api)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/vtex-ads.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_bcf1a06a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides payments integration payment provider homologation in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-guide)\n\n[Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/integrating-a-new-payment-provider-on-vtex)\n\n[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-protocol)\n\n[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-ppp-applied-to-pos)\n\n[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-implementing-a-payment-provider)\n\n[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n\n[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-secure-proxy)\n\n[Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/split-payouts-on-payment-provider-protocol)\n\n[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)\n\n[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/custom-auto-capture-feature)\n\n[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-pix-instant-payments-in-brazil)\n\n[PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/pse-payment-method)\n\n[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-guide)\n\n[Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/integrating-a-new-payment-provider-on-vtex)\n\n[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-protocol)\n\n[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-ppp-applied-to-pos)\n\n[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-implementing-a-payment-provider)\n\n[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n\n[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-secure-proxy)\n\n[Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/split-payouts-on-payment-provider-protocol)\n\n[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)\n\n[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/custom-auto-capture-feature)\n\n[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-pix-instant-payments-in-brazil)\n\n[PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/pse-payment-method)\n\n[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-guide)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation)\n\nPayment Provider Homologation\n\nThe last step to complete the implementation process is to check if the integration was done correctly.\n\nTo do so, you can simulate the integration functioning with the Payment Provider Test Suite app.\n\n## Install the Test Suite app\n\nThere are two ways to download it: accessing the [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-payment-provider-test-suite/p) or through the Admin.\n\nConsidering that you want to download the app through the Admin, proceed as follows:\n\n1. Access the Admin.\n2. Go to the **ACCOUNT SETTINGS** module.\n3. Click on **Apps** then **App Store**.\n4. Now look for **Payment Provider Test Suite** in the search bar.\n5. Click **Install**. \n\n6. After that, you will be redirected to the VTEX App Store. Click the **GET APP** button at the top right corner of the page. \n\n7. Then, on the popup screen, type your account's name - with lowercase and no space in between - and click the **CONFIRM** button. \n\n8. Click **INSTALL** to complete the installation process. \n \nAfter that, the Test Suite app will be installed in your Admin.\n\n## Run the tests\n\nAfter having proceeded with the Homologation process you can start running tests to validate the integration.\n\n### Service information\n\nTo start, fulfill each field according to the instructions below:\n\n* Service URL: The provider’s endpoint. VTEX will use this URL to contact the provider system.\n* Connector Name: How your connector will be named in VTEX. The connector name has necessarily to be related to your brand. Also, the Connector Name is case-sensitive. That means that it considers uppercase and lowercase.\n* X-VTEX-API-AppKey: fulfill it with the value `X-VTEX-API-AppKey`.\n* X-VTEX-API-AppToken: fulfill it with the value `X-VTEX-API-AppToken`.\n\n> Once you define the connector name, it can not be changed.\n\nThen, click the **Check URL** button. This action will call the [GET List Payment Provider Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23get-/manifest) endpoint. The response will indicate which payment methods will be able to be analyzed in the next step (Tests form).\n\n### Tests\n\nAfter the call, the payment methods implemented will be exposed in the form and the switches will be activated automatically.\n\nCheck if the right options were activated. Then, click the **Run Tests** button.\n\n### Logs\n\nAll of the operations realized in the test phase will be exposed in the Logs box, including the ones that may present some error in the integration.\n\nIf errors happen, make all the adjustments necessary to adapt your connector to the Payment Provider Protocol rules and try to run the test again.\n\nIf everything is ok, you need to [open a ticket to the VTEX support team](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM?locale=en) informing them that the integration was completed. However, before opening the ticket, make sure you have the following information:\n\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 email address in case we need 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/vtex-rest-api/docs/payments-integration-purchase-flows).\n\nThe SLA required for the payment team to carry out the homologation is 30 days. This term will start only after the submission of the document **Master Partner Agreement for Financial Services (MPA)**. For homologation requests without using the MPA, the SLA term may be extended due to the need for additional analysis by the payment team.\n\n> Do **not** open the ticket for homologation if the Logs box presents any type of error. Redo the operation until the Logs box results are clear. If you need help in this scenario, talk to your Partner Account Manager.\n\n> It is mandatory to open a ticket with VTEX Support. Without doing so, the implementation will not be recognized by our system.\n\nAfter that, the VTEX support team will inform you whether the implementation was performed correctly.\n\n## When is payment provider homologation not required?\n\nA connector is exempt from the payment provider homologation process only if all of the conditions below are met simultaneously:\n\n* It is a [PPF connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework), developed using [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io).\n* It only uses payment methods already available on the VTEX platform.\n* It is installed locally, restricted to specific accounts.\n* The target account is already using any IO/PPF connector.\n\n> If any of these conditions is not satisfied, the connector must follow the homologation process.\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-payment-provider-homologation.md)\n\n[Payment Methods« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation//docs/guides/payments-integration-payment-methods)[Antifraud Provider ProtocolNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation//docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Install the Test Suite app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23install-the-test-suite-app)\n\n[Run the tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23run-the-tests)\n\n[Service information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23service-information)[Tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23tests)[Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23logs)\n\n[When is payment provider homologation not required?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23when-is-payment-provider-homologation-not-required)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-payment-provider-homologation.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Install the Test Suite app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23install-the-test-suite-app)\n\n[Run the tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23run-the-tests)\n\n[Service information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23service-information)[Tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23tests)[Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23logs)\n\n[When is payment provider homologation not required?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation/docs/guides/payments-integration-payment-provider-homologation%23when-is-payment-provider-homologation-not-required)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_2b7772a2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides expiring a shoppers password in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/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/expiring-a-shoppers-password/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/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/expiring-a-shoppers-password/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/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/expiring-a-shoppers-password/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/expiring-a-shoppers-password/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/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/expiring-a-shoppers-password/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/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/expiring-a-shoppers-password/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/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/expiring-a-shoppers-password/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/expiring-a-shoppers-password/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/api-usage)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/authentication)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/expiring-a-shoppers-password)\n\nExpiring a shopper's password\n\nYou can use the VTEX ID API to expire a shopper's password. This means they will not be able to login until they create a new password on your website.\n\nTo maximize security and improve the shopper experience, we recommend that you follow the steps below to expire a shopper's password:\n\n1. [Activate repeated password prevention](#preventing-repeated-passwords) (do this only the first time)\n2. [Expire shopper password](#expiring-a-password-by-email)\n3. [Notify the shopper](#notifying-the-shopper)\n\n> Any user or [API key](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview) that wishes to perform password expiration must have a [License Manager role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) that includes the `Expire User Password` [resource](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n## Preventing repeated passwords\n\nIf you intend to expire shoppers' passwords, it may be a good idea to prevent them from using the same password repeatedly.\n\nTo do this, use the following API request:\n\n`1\n\nPOST \n\n2\n\nhttps://{{accountName}}.{{environment}}.com.br/api/vtexid/pub/providers/setup/password/webstore/password \n\n`\n\nRequest body:\n\n`1\n\n{ \n\n2\n\n \"isActive\": true, \n\n3\n\n \"allowRepeated\": false \n\n4\n\n} \n\n`\n\n> This configuration impacts all shoppers of your account. You only need to send this request this whenever you want to change this configuration.\n\n## Expiring a password by email\n\nYou can use the API request below to expire the password associated with a specific shopper email:\n\n`1\n\nPOST \n\n2\n\nhttps://{{accountName}}.{{environment}}.com.br/api/vtexid/password/expire?email={{email}} \n\n`\n\nThis request has no body.\n\nA successful response will have status code `200 (OK)` and an empty body.\n\n> This request does not trigger any notification. We strongly recommend that you [notify the user](#notifying-the-shopper) to prevent a frustrating shopping experience next time they try to login to your store.\n\n## Notifying the shopper\n\nOnce you expire a shopper's password, they will not be able to login to your store. You must notify them of the expiration and instruct them to go to your store and create a new password.\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/PedroAntunesCosta)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/authentication/expiring-a-shoppers-password.md)\n\n[Checking which user is currently authenticated« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password//docs/guides/checking-which-user-is-currently-authenticated)[Refresh token flow for headless implementationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password//docs/guides/refresh-token-flow-for-headless-implementations)\n\nSee also\n\n[API authentication using user tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/api-authentication-using-user-tokens)\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/PedroAntunesCosta)\n\nON THIS PAGE\n\n[Preventing repeated passwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/expiring-a-shoppers-password%23preventing-repeated-passwords)\n\n[Expiring a password by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/expiring-a-shoppers-password%23expiring-a-password-by-email)\n\n[Notifying the shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/expiring-a-shoppers-password%23notifying-the-shopper)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/authentication/expiring-a-shoppers-password.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Preventing repeated passwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/expiring-a-shoppers-password%23preventing-repeated-passwords)\n\n[Expiring a password by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/expiring-a-shoppers-password%23expiring-a-password-by-email)\n\n[Notifying the shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password/docs/guides/expiring-a-shoppers-password%23notifying-the-shopper)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e6775735
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore atoms sr only in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-overview)\n\nSROnly\n\nHides an element visually and improves accessibility by providing text to screen readers.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/SROnly)\n\nThe `SROnly` component hides content visually while keeping it available to screen readers. Use it to provide additional context or accessible labels without impacting the visual design.\n\nExample\n\nCode\n\nvisually hidden text\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { SROnly } from '@faststore/ui' \n\n`\n\n### Import Styles into your FastStore project\n\nTo apply the styles of this component in your FastStore project, import the following into your stylesheet:\n\n`1\n\n@import '@faststore/ui/src/components/atoms/SROnly/styles.scss'; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Data attributes\n\nYou can target and override `SROnly` styles using the following data attributes:\n\n`data-fs-sr-only`\n\n> Be cautious when modifying this style, as changes may break its functionality.\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| ---------- | ----------- | ----------------------------------------------------- | ------- |\n| **text\\*** | string | Defines component element type (e.g.: span). | |\n| **as** | ElementType | Defines component element type (e.g.: span, div, h1). | span |\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/sr-only.mdx)\n\n[Select« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-select)[SkeletonNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-skeleton)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only%23import-the-component)[Import Styles into your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only%23import-styles-into-your-faststore-project)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only%23props)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/sr-only.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only%23import-the-component)[Import Styles into your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only%23import-styles-into-your-faststore-project)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-sr-only/docs/guides/faststore/atoms-sr-only%23props)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_dac2f0ec
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides session data aggregation create and transform calls in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/session-manager)\n\n[Session data aggregation: create and transform calls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/session-data-aggregation-create-and-transform-calls)\n\n[Session data available from VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/session-data-available-from-vtex-apps)\n\n[Adding telesales impersonated email using the Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/adding-telesales-impersonated-email-using-the-session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/session-manager)\n\n[Session data aggregation: create and transform calls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/session-data-aggregation-create-and-transform-calls)\n\n[Session data available from VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/session-data-available-from-vtex-apps)\n\n[Adding telesales impersonated email using the Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/adding-telesales-impersonated-email-using-the-session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides)\n\nIntegration Guides\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/session-manager)\n\n[Session data aggregation: create and transform calls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls/docs/guides/session-data-aggregation-create-and-transform-calls)\n\nSession data aggregation: create and transform calls\n\nStrictly speaking, Session Manager is a backend API system that stores and processes session data in JSON objects. Each VTEX account has settings that indicate which installed apps have a session dependency and how they intend to process this information.\n\nApps with a session dependency monitor change to their inputs and modify session parameters through their outputs. When a session parameter changes, Session Manager notifies all apps monitoring it and listens to their response, which indicates whether any other parameters must be updated as a result. Session Manager then patches the session data by compiling the responses sent by all apps, if necessary. We refer to this notification / response / update cycle as **transform call** or transform.\n\nTransforms often trigger other transforms, repeating until apps send no further parameter updates. This operation is, naturally, carefully monitored for loop conditions. The diagram below illustrates one such transform cycle:\n\n\n\n1. A change was made to session parameter X\n2. App A was monitoring session parameter X, so that triggered Transform 1\n3. Transform 1 led App A to change session parameter Y\n4. Apps B and C were monitoring session parameter Y, so that triggered Transform 2\n5. Transform 2 led App B to change session parameter Z\n6. App C was monitoring session parameter Z, so that triggered Transform 3\n7. Transform 3 had no side effects on parameters monitored by apps, so the cycle ended, and the session was saved. In the future, other cycles may start if other changes are made.\n\n> Transform calls are made to all apps simultaneously for the sake of performance. That's why App C was affected both by Transform 2 and Transform 3 - it had no way of knowing that the result of Transform 2 on App B would lead to further changes. When a new session is created, a simpler version of this cycle is executed, which we call **create call**. All apps that have set their configuration with `RunOnCreate: true` will be notified to run simultaneously with an empty input. If these apps modify any parameters that are monitored by other apps, that triggers a transform cycle that will run until the input dependency is resolved.\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/session-manager/session-data-aggregation-create-and-transform-calls.md)\n\n[Session Manager« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls//docs/guides/session-manager)[Session data available from VTEX appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-aggregation-create-and-transform-calls//docs/guides/session-data-available-from-vtex-apps)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/session-manager/session-data-aggregation-create-and-transform-calls.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=)"
}
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.