id
stringlengths 12
53
| messages
listlengths 3
3
|
|---|---|
doc_ca1f36c3
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides layout development guide for payment methods in smart checkout vtex in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/payments-integration-guide)\n\n[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)\n\nLayout Development Guide for payment methods in Smart Checkout VTEX\n\nThis is a guide intended for those responsible for integrating new payment methods into VTEX's Smart Checkout. In addition to the integration with PCI Gateway, it is essential that integrators provide a UI that aligns with the visual identity of the payment method being presented.\n\n> All layout updates made through this guide will only apply to Checkout v6.\n\nWhen a consumer selects their payment method at checkout, they express their interest in using it. Therefore, it is important to communicate, briefly and clearly, how each payment method works and what are the advantages of using each one of them.\n\nAs part of a layout, information such as contact details (e.g. phone number or email), can help the consumer to solve any problem or question at the time of purchase.\n\nThe following sections show how to create a layout to be used for payment methods in VTEX's Smart Checkout.\n\n> You cannot create a new layout for custom payment methods (those developed by the merchant and that only work in their stores, such as notes payable, co-branded, or private label cards).\n\n## Layout Requirements\n\n### User interface: structure and code\n\n#### Bootstrap Framework\n\nThe Smart Checkout code is based on Bootstrap v2.3.2 standards. Classes such as _grid_, _alignment_, and others, can be used to structure the HTML and CSS code.\n\n#### CSS and LESS\n\nThe styling code can be written to be interpreted by our CSS preprocessor, LESS. When writing that code, the following rules are _mandatory_:\n\n* Global selectors which can interfere with the structure or other elements of the page are not permitted.\n* IDs cannot be used as selectors.\n* A maximum of two nested selectors is permitted.\n* All classes must be in English, with lowercase letters and words separated by a hyphen. E.g. _.my-payment-method_.\n\nAdditionally, it is recommended to use only classes as selectors.\n\n#### Responsiveness\n\nThe developed interface must meet the following interfaces:\n\n* **Desktop/Horizontal Tablet**: width greater than or equal to 768 pixels. The container is 462 pixels wide, and its height can vary between 200 and 330 pixels, depending on the content.\n* **Vertical/Mobile Tablet**: width less than 768 pixels. The container is 100% wide, with a margin of 30 pixels and padding of 15 pixels.\n\n> Additional breakpoints can be used freely.\n\n### User interface: design and elements\n\n#### Color and images\n\nThe use of colors and images can follow the visual identity of the payment method, without restrictions. The images must be optimized and grouped into one, using the technique of _css sprites_.\n\n#### Typography\n\nFollowing the Bootstrap pattern, the fonts adopted in Smart Checkout are, in this order:\n\n* Helvetica Neue\n* Helvetica\n* Arial\n* Sans Serif\n\n> It is not recommended to use other fonts for texts. If it is extremely necessary, these fonts must be part of the standard system package, as it is not possible to import new fonts.\n\n#### Scripts and links\n\nScripts and links are not essential for closing the purchase, as they distract the consumer and even take him out of the checkout.\n\n> The use of scripts and links are not permitted.\n\nAll content available at the checkout area should be informative only. The _Checkout button_ must be the only _call-to-action_ presented on the screen.\n\n### Internationalization\n\nAll texts must be produced in:\n\n* **en-US**: US English (mandatory) and,\n* Languages of the countries/regions where you intend to operate (if not in English). See [ISO 639-1 Standard Language Codes](https://read.calvincode.net/reader?url=https://www.andiamo.co.uk/resources/iso-language-codes/).\n\nIn addition to localizing the texts, images should be altered to better suit each language.\n\n### Development\n\n> Use [Payment Mocker](https://read.calvincode.net/reader?url=https://github.com/vtex/payment-mocker) to test your layout rendering within VTEX's Smart Checkout to ensure expected behavior.\n\nFollow these steps to create your layout:\n\n1. Download the repository to your local machine (either through the Github clone or by downloading the repository from the download option). \n\n2. Install the [NodeJS](https://read.calvincode.net/reader?url=https://nodejs.org/en/).\n3. Enter the following commands in the terminal to install Grunt and Sass: \n * **Grunt**: `sudo npm i -g grunt-cli` \n * **Saas**: `sudo npm install -g sass`\n4. Still in the terminal, go to the project folder and run the command `npm i` ; wait for the project's dependencies to be installed.\n5. Run the command _Grunt_ on the project folder.\n6. Open your preferred browser and go to the link `http://localhost:8080`.\n7. Modify the following files in accordance with the requirements of the User interface: structure and code section: \n * _src/partials/payment.html_: This file is where you should insert the HTML structure of your layout. When adding information about a new payment method, change the text `newpayment` in the file to the name of the payment method created. For example, when creating the Safety Pay payment method, replace the information `newpayment` with `SafetyPay`. \n * _src/assets/css/less/style.less_: This is where you insert the classes responsible for styles, spacing, fonts, and other CSS customizations in your layout. Remember to follow the guidelines described in the section above. \n * _src/assets/img_: Here you should insert and refer to all the images used in your layout. \n * _src/i18n_: Inside this folder you are going to find four files, each one corresponding to one language (_pt-BR, en-US, es, and fr_). You should change the values for the keys and check if the languages are rendered correctly by clicking on the flags located in the upper left corner in the Payment Mocker, see the example in the section below.\n8. Open the file _src/assets/css/less/style.less_, get access to the property _#payment-group-template-PaymentGroup_ _.payment-group-item-text_ and update the attribute background-image, in order to insert the icon referring to your payment method.\n\n> If there is no change in the attribute _background-image_, no icon will be rendered next to the payment method label.\n\n1. Open the file _src/i18n/{language}.json_, and change the value of the _paymentData.paymentGroup.title_ key, in order to customize the label that your payment method will be rendered on checkout.\n\n> If the value of the _paymentData.paymentGroup.title_ key is not changed, the payment method will be rendered with the default label. Likewise, if the name chosen for your new payment method is the same or similar to one of the existing payment method on the VTEX platform, it will not be possible to register it. To check the payment methods already registered, access the VTEX Admin, and go to **Store Settings > Payments > Settings > Payment Conditions**.\n\n### Delivery\n\nTo deliver the code (which is a repository of the Payment Mocker containing all modifications related to your payment methods), you must compress it in .zip or .rar extensions, and submit it by opening a ticket on the [VTEX Support Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/support).\n\n> You must delete any additionally files or folders created during the compilation process of the project, such as, the folder _node\\_modules_ or file _yarn.lock_ (e.g. for those use yarn package manager).\n\n## Layout Example\n\nSee below an example of layout and language switching ([Brastemp](https://read.calvincode.net/reader?url=http://loja.brastemp.com.br/)) for payment methods located in VTEX's Smart Checkout payment methods.\n\n> Any manual language switching is only available in the Payment Mocker for testing purposes. Once the layout is deployed, the language switching is made by the Checkout automatically.\n\n\n\n\n\n### Reference Links\n\n[GitHub - Payment Mocker - HTML](https://read.calvincode.net/reader?url=https://github.com/vtex/payment-mocker/blob/master/src/partials/payment.html)\n\n[GitHub - Payment Mocker - CSS](https://read.calvincode.net/reader?url=https://github.com/vtex/payment-mocker/blob/master/src/assets/css/less/style.less)\n\n[GitHub - Payment Mocker - Internationalization](https://read.calvincode.net/reader?url=https://github.com/vtex/payment-mocker/tree/master/src/i18n)\n\nContributors\n\n4\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/PedroAntunesCosta)\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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex.md)\n\n[Split Payouts on Payment Provider Protocol« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex//docs/guides/split-payouts-on-payment-provider-protocol)[Custom Auto Capture FeatureNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex//docs/guides/custom-auto-capture-feature)\n\nContributors\n\n4\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/PedroAntunesCosta)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Layout Requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23layout-requirements)\n\n[User interface: structure and code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23user-interface-structure-and-code)[User interface: design and elements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23user-interface-design-and-elements)[Internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23internationalization)[Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23development)[Delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23delivery)\n\n[Layout Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23layout-example)\n\n[Reference Links](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23reference-links)\n\nWas this helpful?\n\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/layout-development-guide-for-payment-methods-in-smart-checkout-vtex.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Layout Requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23layout-requirements)\n\n[User interface: structure and code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23user-interface-structure-and-code)[User interface: design and elements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23user-interface-design-and-elements)[Internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23internationalization)[Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23development)[Delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23delivery)\n\n[Layout Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23layout-example)\n\n[Reference Links](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex%23reference-links)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_f7fc67af
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides applicable cases in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/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/applicable-cases/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/recaptcha)\n\n[Applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/applicable-cases)\n\n[Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/implementing-recaptcha-in-integrations)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/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/applicable-cases/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/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/applicable-cases/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/applicable-cases/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/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/applicable-cases/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/recaptcha)\n\n[Applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/applicable-cases)\n\n[Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/implementing-recaptcha-in-integrations)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/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/applicable-cases/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/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/applicable-cases/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/applicable-cases/docs/guides)\n\nIntegration Guides\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/recaptcha)\n\n[Applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases/docs/guides/applicable-cases)\n\nApplicable cases\n\nWhen a shopper places an order on your store paying with a credit or debit card, they may or may not be required to perform reCAPTCHA validation according to the criteria set in the [orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updateorderformconfiguration).\n\nThe `vtexCriteria` option uses an algorithm to determine which sessions are trustworthy. This reduces the application of reCAPTCHA validation, improving security with no impact conversion. This is the recommended option if you are using checkbox validation (equivalent to reCAPTCHA v2).\n\nRegardless of this configuration, reCAPTCHA verification will not be required in some cases:\n\n* Fulfillment orders, meaning orders received through a marketplace, in which your store is responsible only for the fulfillment. In this case, reCAPTCHA validation is applied in the marketplace where the order was made by the shopper according to its own configuration.\n* Orders made by authenticated administrator users, including [call center users](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-can-i-create-callcenter-user--frequentlyAskedQuestions%5F4227%23).\n* Orders made through the private (`/pvt`) placeOrder API endpoint, which is commonly used by integrations and authenticated with appKey and appToken.\n* Orders where payment does not include a debit or credit card.\n\nContributors\n\n2\n\n[](https://github.com/PedroAntunesCosta)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/recaptcha/applicable-cases.md)\n\n[reCAPTCHA« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases//docs/guides/recaptcha)[Implementing reCAPTCHA in integrationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/applicable-cases//docs/guides/implementing-recaptcha-in-integrations)\n\nContributors\n\n2\n\n[](https://github.com/PedroAntunesCosta)\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/recaptcha/applicable-cases.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_b1fb78c9
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore search search provider in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-overview)\n\n[SearchProvider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-search-provider)\n\n[usePagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-use-pagination)\n\n[useSearch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-use-search)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-overview)\n\n[SearchProvider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-search-provider)\n\n[usePagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-use-pagination)\n\n[useSearch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-use-search)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/sdk-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-overview)\n\nSearchProvider\n\n`SearchProvider` is a React component that wraps an entire page, such as a Product Listing Page, to provide the necessary context for the faceted search. Faceted search allows users to filter and refine search results based on specific attributes (such as price, category, brand, etc.).\n\n## Import\n\n`1\n\nimport { SearchProvider } from '@faststore/sdk' \n\n`\n\n## Usage\n\nThe following example demonstrates how to implement faceted search using `SearchProvider`:\n\n`1\n\nimport { SearchProvider, parseSearchState } from '@faststore/sdk' \n\n2\n\n \n3\n\nfunction Page () { \n\n4\n\n const params = useMemo(() => parseSearchState(new URL(window.href)), []) \n\n5\n\n \n6\n\n return ( \n\n7\n\n <SearchProvider \n\n8\n\n onChange={(url: URL) => window.location.href = url.href} \n\n9\n\n itemsPerPage={12} \n\n10\n\n {...params} \n\n11\n\n > \n\n12\n\n {children} \n\n13\n\n </SearchProvider> \n\n14\n\n ) \n\n15\n\n} \n\n`\n\n* `SearchProvider`: React component that provides search context.\n* `parseSearchState`: Parses the current URL and extracts the search state (such as `sort`, `term`, `page`, etc.).\n* `children`: Components wrapped by `SearchProvider`, which will have access to the search context.\n\n## Props\n\nThe `SearchProvider` component accepts the following props:\n\n| Prop | Type | Description |\n| -------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |\n| onChange | (url: URL) => void | Callback function that handles changes in the facet state. It updates the page URL when search parameters change. |\n| itemsPerPage | number | Number of items displayed on a given page. |\n| sort | SearchSort | Sorting criteria of the search result (such as price\\_asc, orders\\_desc, discount\\_desc, etc.). |\n| term | string / null | Full-text term used in the search. |\n| page | number | Current page index in search pagination. |\n| base | string | Base URL path of the search page. Useful for localization and prefixing paths by locale (such as /en-us/). |\n| selectedFacets | Array<{ key: string, value: string }> | Array of selected facets in the search. |\n| passThrough | URLSearchParams | Additional URL parameters to preserve when building URLs. |\n\n> Don't include personalization facets, such as sales channel and price tables, in the `selectedFacets` property. Doing so may result in users having two channels — one from the Session context and another from the URL — which may lead to unexpected behavior.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/search/search-provider.mdx)\n\n[Search« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-overview)[usePaginationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-use-pagination)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-search-provider%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-search-provider%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-search-provider%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/docs/sdk/search/search-provider.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-search-provider%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-search-provider%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/search-search-provider/docs/guides/faststore/search-search-provider%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_33ef5e25
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore reference icons in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-overview)\n\nIconography\n\nThis set of icons uses SVGs from Phosphor icons.\n\nIcons help build web pages by illustrating concepts and improving website navigation.FastStore offers a set of icons that our components use, and you can also use them on your application. This set of icons uses SVGs from [Phosphor icons](https://read.calvincode.net/reader?url=https://phosphoricons.com/).\n\n---\n\n## Import\n\nImport the component from [@faststore/ui](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index)\n\n`1\n\nimport { Icon } from '@faststore/ui' \n\n`\n\nYou can find more details about the `Icon` component [here](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon).\n\n## Usage\n\n`1\n\n<Icon name=\"X\" weight=\"bold\" /> \n\n2\n\n<Icon name=\"MagnifyingGlass\" weight=\"regular\" /> \n\n3\n\n<Icon name=\"House\" weight=\"thin\" /> \n\n`\n\n`1\n\n<Icon name=\"X\" weight=\"bold\" width={16} height={16} /> \n\n2\n\n<Icon name=\"MagnifyingGlass\" weight=\"regular\" width={20} height={20} /> \n\n3\n\n<Icon name=\"House\" weight=\"thin\" width={32} height={32} /> \n\n`\n\n---\n\n### UI Actions\n\n* X\n* Plus\n* PlusCircle\n* Minus\n* MinusCircle\n* XCircle\n* ArrowLeft\n* ArrowRight\n* ArrowElbowDownRight\n* CaretDown\n* CaretRight\n* CaretLeft\n* CaretUp\n* Checked\n* MagnifyingGlass\n* FadersHorizontal\n\n### Payment Flags\n\n* Visa\n* Amex\n* ApplePay\n* EloCard\n* Diners\n* GooglePay\n* Mastercard\n* PayPal\n* Pix\n* Stripe\n* GooglePay\n* ApplePay\n* Visa\n\n### Social\n\n* Facebook\n* Instagram\n* Twitter\n* Pinterest\n\n### Others\n\n* House\n* Star\n* Heart\n* DotsThree\n* Ruler\n* ShoppingCart\n* Tag\n* BellRinging\n* Bell\n* MapPin\n* ArrowSquareOut\n* Envelop\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/icons.mdx)\n\n[Typography« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/global-tokens-typography)[Using themesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/using-themes-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23usage)\n\n[UI Actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23ui-actions)[Payment Flags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23payment-flags)[Social](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23social)[Others](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23others)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/icons.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23usage)\n\n[UI Actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23ui-actions)[Payment Flags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23payment-flags)[Social](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23social)[Others](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons/docs/guides/faststore/styling-icons%23others)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_6ab92412
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides deprecated order 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/deprecated-order-logs/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-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/deprecated-order-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/deprecated-order-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/deprecated-order-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/deprecated-order-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/deprecated-order-logs/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/updates/release-notes)\n\n\\[Deprecated\\] Order Logs\n\n> We have released a new method for integrating orders from external marketplaces, as a part of our Marketplace Protocol. If you used this previous method for integrating orders, you can still find their documentation in [Order Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/deprecated-order-logs) and [How to collect orders from sales channels](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/deprecated-how-to-collect-orders-from-sales-channels). These previous methods, however, will not be maintained. If you are integrating orders for the first time, we recommend you use the instructions in our [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-collect-orders) guide.\n\nConnectors should present the logs that follow, considering their status:\n\n| **Status** | **Description** |\n| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Success | Occurs when the exchange of messages between VTEX, connector and marketplace flow successfully. |\n| Error | Occurs when the exchange of messages between VTEX, connector and marketplace present errors due to communication (500) or business errors (400). Recommendations: for 500 errors, it is highly recommended to use the contingency flow through the reprocessing queue with at least 10 attempts. After the attempt number is exceeded, we recommend using a DEADLETTER queue for infinite retrials. |\n| Alert | Occurs when the exchange of messages between VTEX, connector and marketplace are able to process, but with a needed action from one of the systems involved. |\n| Pending | Occurs when the exchange of messages between VTEX, connector and marketplace are in progress. Ex. SKUs are still in the connector’s processing queue, or waiting an async response from the marketplace. |\n\n## Content of the messages\n\nThe messages contained in logs should follow the standard defined below, allowing the user who operates VTEX platform and catalog to understand the situation:\n\n1. **Operation ID (id)**: allows to identify the unique log in any sort of operation.\n2. **Operation**: identifies if an operation is a Catalog change, Offer creation, Price update, Inventory update, Order status update, Invoice sending, Tracking code sending.\n3. **Direction**: allows to identify the origin and destination of the information. Ex. VTEX to Marketplace.\n4. **Content Source**: payload sent by the origin solution. Ex. Order’s json, connected from the marketplace, allowing to identify the original message sent by the origin app.\n5. **Content Translated**: message generated by the connector with transformations, filers and enrichments needed, allowing sellers to understand the actions executed.\n6. **Content destination**: original payload sent by the destination software after processing trial.\n7. **Business message**: in case of errors, message explaining the error under the business contexto, with guidance on how to solve the problem.\n8. **Status**: should include the statuses of success, error, warning and pending.\n\n## Log messages\n\nEach step of the catalog integration requires a specific set of Log messages. The table describes all messages, for each scenario within the integration.\n\n| Code | Event | User message | Error status | Response |\n| ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------- |\n| A | When integrating the order successfully in VTEX | The order {{marketplaceOrderId}} was created in VTEX successfully under the ID {{vtexOrderId}}. _Link to the order within VTEX._ | Success | 201 |\n| B | When sending the SKU register to the marketplace | The standard rule with 0-100% manual approval was created successfully. To view or change this rule click [here](https://read.calvincode.net/reader?url=https://accountname.myvtex.com/admin/order-auth) | Success | 201 |\n| C | When sending the cancel order request | The order {vtexOrderId} has been cancelled successfully. | Success | 201 |\n| D | When using the [Fulfillment simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) API, the SKU is not retrieved in the items object. | Oops, we couldn’t obtain the information of SKU {{skuId}}. Please check if the items below are configured correctly in the VTEX platform. In product registration, check if it is associated with the trade policy. In [fulfillment simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation), check if the carrier attending the SKU exists. In price configuration, check if there’s a price associated with the trade policy. | Warning | 400 |\n| E | When trying to send the Cancel Order request and receiving failure for multiple requests | Oops, we could not cancel the order right now, due to the high volume of requests we’re receiving. We’ll try again later. If you prefer, you can cancel the order directly in VTEX. | Alert | 400 |\n| F | When checking if the SKU is inactive \\\\ | Oops, the SKU is inactive in VTEX. We recommend that you check:In Catalog, identify the SKU and check if the field “Activate SKU” is checked. In Catalog, check if the image is uploaded. In [fulfillment simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation), check if the carrier attending the SKU exists. On price configuration, check if there’s a price associated with the trade policy. | Warning | 400 |\n| G | When trying to cancel an order that has already been manually cancelled in VTEX | The order {vtexOrderId} has already been cancelled in VTEX. | Error | 500 |\n| H | When receiving an error about divergences | Oops, we couldn’t find the values needed for order placement, with standard values accepted by the marketplace. {{list containing FIELD and VALUE attributed}} | Warning | 200 |\n| I | When transforming Order data to the format demanded by the marketplace. | Oops, we couldn't prepare the SKU registration in the marketplace due to {{list all errors occurred during data transformation, and in case any data infringes marketplace rules}}. (Connectors should list all errors at once, so the user knows all actions needed to send the SKU). | Error | 400 |\n| J | Error when trying to create price divergence standard rule | Oops, we were not able to create the standard price divergence rule. Please try again later. | Error | 400 |\n| K | When trying to cancel an order with invalid credentials | Oops, we were not able to communicate with VTEX to cancel the Order. Please check if your integration’s settings are correct. | | |\n| L | When trying to communicate with the marketplace API used to register the product | Oops, the product registration in the {name} marketplace is unavailable right now. Don’t worry - we’ll try again in a few minutes. In case the problem persists, get in touch with the marketplace. | Error | 500 |\n| M | When trying to cancel an order that has not been integrated in VTEX | Oops, the order {vtexOrderId} has not been integrated in VTEX yet. We’ll try again later. | | |\n| N | When sending the product registration to the marketplace, and obtaining failure for sending incorrect data. | Oops, we couldn't prepare the SKU registration in the marketplace due to {list all errors occurred during data transformation, and in case any data infringes marketplace rules}. (Connectors should list all errors at once, so the user knows all actions needed to send the SKU). | Error | 400 |\n| O | When trying to collect the category or attribute mapping from the VTEX Mapper. | Oops, we couldn’t find the category {name of the category} mapping of the {SKU name + ID} SKU in the marketplace. Please access the link below to perform this mapping. {Link indicating the store’s mapper}. | Error | 400 |\n| P | When trying to communicate with the mapping API from the mapper. | Oops, the VTEX category mapping is unavailable right now. Don’t worry - we’ll try again in a few minutes. In case the problem persists, get in touch with support. | Error | 500 |\n| Q | When trying to reprocess an order that is already canceled in the marketplace due to inventory error | Oops, we couldn’t reprocess the order {{orderId}} of the {{marketplaceName}}, since this order was cancelled manually in the marketplace. | Error | 400 |\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/external-marketplace-integration-guide/deprecated-order-logs.md)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/docs/guides/deprecated-order-logs%23content-of-the-messages)\n\n[Log messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/docs/guides/deprecated-order-logs%23log-messages)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/deprecated-order-logs.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/docs/guides/deprecated-order-logs%23content-of-the-messages)\n\n[Log messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs/docs/guides/deprecated-order-logs%23log-messages)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_f88c14c8
|
[
{
"role": "system",
"content": "You are a VTEX 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 deprecated 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-deprecated-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-deprecated-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-deprecated-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-deprecated-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-deprecated-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-deprecated-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-deprecated-apps/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/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-io-deprecated-apps/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/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-io-deprecated-apps/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/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-io-deprecated-apps/docs/vtex-io-apps)\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/guides/vtex-io-deprecated-apps)\n\nVTEX IO deprecated apps\n\nCheck here which apps are no longer supported or maintained by VTEX.\n\nA deprecated app refers to an application no longer supported or maintained by VTEX, meaning that:\n\n* VTEX no longer provides technical support.\n* VTEX is not liable for issues arising from its use.\n* VTEX will not provide bug fixes, updates, or security patches.\n* VTEX will not develop new features.\n* The documentation will not be updated.\n\nBelow is a [list of deprecated apps](#list-of-deprecated-apps). If you’re using any of them, take appropriate action to remove or replace them.\n\n> Learn how to check if you’re using a deprecated app in [Checking your store’s apps](#checking-your-stores-apps).\n\n## List of deprecated apps\n\n### Account management\n\n| App | vendor.app-name |\n| ---------------- | --------------------- |\n| Binding Selector | vtex.binding-selector |\n| Franchise Setup | vtex.franchise-setup |\n\n### Analytics\n\n| App | vendor.app-name |\n| ---------- | ---------------- |\n| AB Tester | vtexarg.abtester |\n| Lightspeed | vtex.lightspeed |\n\n### Catalog\n\n| App | vendor.app-name |\n| ------------------------- | -------------------------------------------------------- |\n| Admin Catalog Translation | vtex.admin-catalog-translations |\n| Assembly Options | vtex.admin-assembly-optionsvtex.assembly-options-graphql |\n| Export Feeds IO | vtex.export-feeds-io |\n| Google Catalog Import | vtex.sheets-catalog-import |\n| Google Drive Import | vtex.google-drive-import |\n| Massive Score Update | vtexarg.massive-score-update |\n\n### Checkout\n\n| App | vendor.app-name |\n| ------------------------ | ----------------------------------- |\n| Checkout IO | vtex.checkout-custom-template |\n| Checkout UI Custom | vtex.checkout-ui-custom |\n| Checkout V6 Invoice Data | vtexeurope.checkout-v6-invoice-data |\n| Cross Device Cart | vtex.cross-device-cart |\n| GiveX | vtex.givex |\n| TSYS Gift Cards | vtex.tsys-merchantware |\n\n### Content management\n\n| App | vendor.app-name |\n| ------ | ------------------------- |\n| GeoCMS | vtex.geocms-store-locator |\n| Yext | vtex.yext-store-locator |\n\n### Data management\n\n| App | vendor.app-name |\n| ------------------- | ------------------------------------------------ |\n| Customer Management | vtex.admin-customersvtex.admin-customers-graphql |\n\n### Multi-language and multi-currency\n\n| App | vendor.app-name |\n| ----------------------- | ------------------------------ |\n| Catalog Translation API | vtex.catalog-translations-rest |\n| Currency Selector | vtex.currency-selector |\n\n### Logistics\n\n| App | vendor.app-name |\n| ----------------------------------------- | ---------------------------- |\n| Curbside Pickup | vtex.curbside-pickup |\n| Delivery Window Blocker | vtex.delivery-window-blocker |\n| EasyPost | vtex.easypost |\n| Fedex Shipping | vtex.fedex-shipping |\n| innoship app | vtex.innoship |\n| Location Availability (Inventory Locator) | vtex.location-availability |\n| Massive Stock Update | vtexarg.massive-stock-update |\n| Package Optimizer (FedEx Shipping) | vtex.packing-optimization |\n| Return App | vtex.return-app |\n| ShipStation | vtex.ship-station |\n| Shopper Location (Inventory Locator) | vtex.shopper-location |\n| Store Locator | vtex.store-locator |\n\n### Marketing and sales\n\n| App | vendor.app-name |\n| ----------------------------- | --------------------------------- |\n| Abandoned Cart | vtex.abandoned-cart |\n| Affiliates | vtex.affiliates |\n| Affiliates Commission Service | vtex.affiliates-comission-service |\n| Affiliates Program | vtex.affiliates-order-form-spy |\n| Marketing Autopilot | vtexbr.marketing-autopilot |\n\n### Marketplace\n\n| App | vendor.app-name |\n| ------------------------------ | -------------------------------------- |\n| Advanced seller onboarding | vtexromania.advanced-seller-onboarding |\n| Glovo | vtex.glovo-integration |\n| Lengow | vtex.lengow-integration |\n| Mktplace Financial Commissions | vtex.marketplace-financial-commission |\n| Mktplace Mapper | vtex.seller-mkp-mapper |\n| Octopia (casino) | vtex.octopia-integration |\n| Seller Products Import | vtex.seller-products-import |\n\n### Observability\n\n| App | vendor.app-name |\n| -------------- | ------------------------ |\n| Logger GraphQL | vtex.vtex-logger-graphql |\n| Logger React | vtex.vtex-logger-react |\n\n### Orders\n\n| App | vendor.app-name |\n| --------------------- | ---------------------------- |\n| Lightspeed | vtex.lightspeed |\n| Order Quote | vtex.orderquote |\n| Order Summary | vtex.external-invoice-viewer |\n| Order Bulk Import | vtex.admin-order-bulk-import |\n| Smartbill Integration | vtex.smartbill |\n| Yotpo Integration | vtex.yotpo-integration |\n\n### Payments\n\n| App | vendor.app-name |\n| ---------------------------- | ----------------------------------------- |\n| Bizum (PPP) | vtex.integration-bizum |\n| Cetelem (PPP) | vtex.integration-cetelem |\n| Digital River | vtexus.connector-digital-river |\n| GestPay (PPP) | vtex.ppp-gestpay |\n| Instore Payments North Latam | vtex.order-instore |\n| Mollie (PPP) | vtex.integration-mollie |\n| ONEY (PPP) | vtex.oney-auth-app |\n| Payment APP TuyaPay | vtexcol.tuyapay-payment-authorization-app |\n| Sequra (PPP) | vtex.sequra-connector |\n| Sequra promotions | vtex.sequra-promotions |\n| Stripe Connect (PPP) | vtex.ppp-stripe-connect |\n| WorldLine SIPS (casino) | vtex.ppp-worldline-sips |\n\n### Pixel\n\n| App | vendor.app-name |\n| ------------------ | --------------------------- |\n| accessiBe | vtex.accessibe |\n| Adobe Launch Pixel | vtexasia.adobe-launch-pixel |\n| Digioh | vtex.digioh-pixel |\n| edrone pixel | vtexromania.edrone |\n| Klaviyo | vtex.klaviyo-pixel |\n| Listrak | vtex.listrak-pixel |\n| newsman pixel | vtex.newsman |\n| Podium | vtex.podium-pixel |\n| retargeting pixel | vtex.retargeting |\n| Treasure Data | vtex.treasure-data-pixel |\n| Wordpress App | vtex.wordpress-integration |\n\n### Pricing and promotions\n\n| App | vendor.app-name |\n| ----------------------------- | ------------------------------------------- |\n| External Promotion Provider | vtex.external-promotion-provider-middleware |\n| Massive Price Update | vtexarg.massive-price-update |\n| Tintometric (for paint shops) | vtexarg.tintometric |\n\n### Shopper experience\n\n| App | vendor.app-name |\n| -------------------------- | ---------------------------------------------------------- |\n| Availability Notifier | vtex.availability-notify |\n| Buy Box | vtex.buybox-resolvervtex.buybox-contextvtex.buybox-graphql |\n| Kit Look | vtex.kit-look |\n| Minicart free shipping bar | vtexeurope.minicart-freeshipping-bar |\n| Pickup Selector | vtex.pickup-selector |\n| Power Reviews | vtex.powerreviews |\n| QR & Bar Code Reader | vtexarg.qr-barcode-reader |\n| Quantity on Cart | vtexarg.quantity-on-cart |\n| Questions and Answers | vtex.questions-and-answers |\n| Reviews and Ratings | vtex.reviews-and-ratings |\n| Shopper Approved | vtex.shopper-approved |\n| Speech to Text | vtexarg.speech-to-text |\n| Viewed products | vtex.viewed-products |\n| Wishlist | vtex.wish-list |\n| Yotpo | vtex.yotpo |\n| Yotpo UGC | vtex.yotpo-visual-ugc |\n\n### Store management\n\n| App | vendor.app-name |\n| ----------------- | ---------------------- |\n| WorkSpace Manager | vtex.workspace-manager |\n\n### Storefront\n\n| App | vendor.app-name |\n| ------------------ | --------------------------- |\n| Badges | vtex.badges |\n| Bazaarvoice | vtex.bazaarvoice |\n| Disposition Layout | vtex.disposition-layout |\n| Info card list | vtex.info-card-list-context |\n| Mega Menu | vtex.mega-menu |\n| Toggle Layout | vtex.toggle-layout |\n\n### Tax service\n\n| App | vendor.app-name |\n| -------- | --------------- |\n| Avalara | vtex.avalara |\n| TaxJar | vtex.taxjar |\n| Taxproxy | vtex.tax-proxy |\n| Vertex | vtex.vertex |\n\n## Checking your store’s apps\n\nTo identify if your store is using a deprecated app, [review its dependencies](#review-dependencies) and [check the installed apps](#check-the-installed-apps).\n\n### Review dependencies\n\nReview any [dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-dependencies) your store may have:\n\n1. Open the app's project using the code editor of your choice.\n2. Open the [manifest.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest) file.\n3. Under the `dependencies` object, check the apps listed.\n\n### Check the installed apps\n\nCheck the apps installed in your account:\n\n1. Open the terminal and run the `vtex list` command.\n2. Identify the apps installed.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-io-deprecated-apps.md)\n\n[My Authentication« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps//docs/apps/vtex.my-authentication)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[List of deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23list-of-deprecated-apps)\n\n[Account management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23account-management)[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23analytics)[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23catalog)[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23checkout)[Content management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23content-management)[Data management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23data-management)[Multi-language and multi-currency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23multi-language-and-multi-currency)[Logistics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23logistics)[Marketing and sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23marketing-and-sales)[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23marketplace)[Observability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23observability)[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23orders)[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23payments)[Pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23pixel)[Pricing and promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23pricing-and-promotions)[Shopper experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23shopper-experience)[Store management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23store-management)[Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23storefront)[Tax service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23tax-service)\n\n[Checking your store’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23checking-your-stores-apps)\n\n[Review dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23review-dependencies)[Check the installed apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23check-the-installed-apps)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-io-deprecated-apps.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[List of deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23list-of-deprecated-apps)\n\n[Account management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23account-management)[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23analytics)[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23catalog)[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23checkout)[Content management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23content-management)[Data management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23data-management)[Multi-language and multi-currency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23multi-language-and-multi-currency)[Logistics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23logistics)[Marketing and sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23marketing-and-sales)[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23marketplace)[Observability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23observability)[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23orders)[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23payments)[Pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23pixel)[Pricing and promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23pricing-and-promotions)[Shopper experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23shopper-experience)[Store management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23store-management)[Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23storefront)[Tax service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23tax-service)\n\n[Checking your store’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23checking-your-stores-apps)\n\n[Review dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23review-dependencies)[Check the installed apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-deprecated-apps/docs/guides/vtex-io-deprecated-apps%23check-the-installed-apps)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_8a664a5d
|
[
{
"role": "system",
"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 antifraud provider protocol API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/antifraud-provider-protocol/)\n\nAnti-fraud Flow\n\nOAuth Flow\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/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/antifraud-provider-protocol/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/antifraud-provider-protocol/)\n\nAnti-fraud Flow\n\nOAuth Flow\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/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/antifraud-provider-protocol/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoSend Anti-fraud Pre-Analysis Data (optional)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol/docs/api-reference/antifraud-provider-protocol%23post-/pre-analysis)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b8a960dc
|
[
{
"role": "system",
"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 payment provider protocol API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/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/payment-provider-protocol/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/payment-provider-protocol/)\n\nPayment Flow\n\nConfiguration Flow\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/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/payment-provider-protocol/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/payment-provider-protocol/)\n\nPayment Flow\n\nConfiguration Flow\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[DeRemove values from organization unit scope« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/organization-units-api%23delete-/api/organization-units/v1/-organizationUnitId-/scopes/-scope-/remove)[GeList Payment Provider ManifestNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol/docs/api-reference/payment-provider-protocol%23get-/manifest)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_c7ff581d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides can i order my product as i want in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/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/can-i-order-my-product-as-i-want/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/storefront-development)\n\n(Legacy) CMS Portal\n\n[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/can-i-order-my-product-as-i-want)\n\nCan I order my product as I want?\n\nBy default, VTEX system orders products according to their relevance on the site, i.e. by most sold and most viewed.\n\nHowever, there are ways to change this order: either through the Score field or by using Querystring. How the Score field works is explained in [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-the-score-field-works--1BUZC0mBYEEIUgeQYAKcae).\n\nThe Querystring process is simpler: simply incert the parameter into the URL to change the order in which products are displayed.\n\nThe parameters are as follows:\n\n* **Lowest price**: `?O=OrderByPriceASC`\n* **Highest price**: `?O=OrderByPriceDESC`\n* **Best sellers**: `?O=OrderByTopSaleDESC`\n* **Best rated**: `?O=OrderByReviewRateDESC`\n* **Alphabetical order A-Z**: `?O=OrderByNameASC`\n* **Alphabetical order Z-A**: `?O=OrderByNameDESC`\n* **Release date (associated with the product)**: `?O=OrderByReleaseDateDESC`\n* **Highest discount**: `?O=OrderByBestDiscountDESC`\n* **Lowest discount**: `?O=OrderByBestDiscountASC`For example: `http://www.{AccountName}.com/{departament}/{category}?O=OrderByPriceASC`\n\n> You can only use one product order parameter at a time. Therefore, you have to choose the one that best suits your store's needs (remember that parameters can be changed at will).\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/acnmello)\n\n[](https://github.com/jumeyermattosarruda)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/legacy-cms/can-i-order-my-product-as-i-want.md)\n\n[Migrating your storefront from Legacy CMS Portal to Store Framework« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want//docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)[List of controls for templatesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want//docs/guides/list-of-controls-for-templates)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/acnmello)\n\n[](https://github.com/jumeyermattosarruda)\n\nWas this helpful?\n\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/can-i-order-my-product-as-i-want.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_4c31ebf5
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation vtex io cli installation and command reference in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-install)\n\n[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-update)\n\n[Using VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-usage)\n\n[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)\n\n[Command reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)\n\n[Uninstalling VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-install)\n\n[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-update)\n\n[Using VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-usage)\n\n[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)\n\n[Command reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)\n\n[Uninstalling VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/app-development)\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\nVTEX IO CLI\n\nLearn more about VTEX IO CLI: a powerful and essential command-line tool for developers to interact with the VTEX platform\n\nThe VTEX IO CLI (Command Line Interface) is the starting and ending point for any development on the VTEX platform. It provides developers with the ability to perform a wide range of actions essential to the development process, including linking local files to the VTEX platform, managing workspaces, and releasing new app versions.\n\n> Different from the previous version, VTEX IO CLI 3.x has a plugin-based architecture. See [what changed](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/new-version-of-vtex-io-cli-released), or access [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins) to learn more about VTEX IO CLI plugins.\n\n[Installing VTEX IO CLILearn how to install VTEX IO CLI according to your operating system.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install)[Using VTEX IO CLIDiscover the most commonly used VTEX IO CLI commands and how to utilize them.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-usage)[Managing pluginsList, update, install or remove VTEX IO CLI plugins.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)[Command referenceCheck this comprehensive list of all available VTEX IO CLI commands, their functions, examples, and syntax.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)[Updating VTEX IO CLILearn how to update the VTEX IO CLI to its latest version.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update)[Uninstalling VTEX IO CLILearn how to completely uninstall VTEX IO CLI from your machine.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)[ChangelogCheck the latest changes in the VTEX IO CLI repository.See more](https://read.calvincode.net/reader?url=https://github.com/vtex/toolbelt/blob/main/CHANGELOG.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/vtex-io-documentation-vtex-io-cli-installation-and-command-reference.md)\n\n[Peer Dependencies« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference//docs/guides/vtex-io-documentation-peerdependencies)[Installing VTEX IO CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference//docs/guides/vtex-io-documentation-vtex-io-cli-install)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/vtex-io-documentation-vtex-io-cli-installation-and-command-reference.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_3f3ef046
|
[
{
"role": "system",
"content": "You are a VTEX 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 newsletter opt in with master data v1 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-newsletter-opt-in-with-master-data-v1/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/api-reference)\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-newsletter-opt-in-with-master-data-v1/docs/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-newsletter-opt-in-with-master-data-v1/docs/storefront-development)\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-newsletter-opt-in-with-master-data-v1/docs/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-newsletter-opt-in-with-master-data-v1/docs/troubleshooting)\n\n[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-newsletter-opt-in-with-master-data-v1/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/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/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-v1)\n\n[Querying documents in Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/querying-documents-in-master-data-v1)\n\n[Implementing newletter opt-in with Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1)\n\n[Uploading files to Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/uploading-files-to-master-data-v1)\n\n[Interacting with Master Data v1 through VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/interacting-with-master-data-v1-through-vtex-io-services)\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/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/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/implementing-newsletter-opt-in-with-master-data-v1/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/implementing-newsletter-opt-in-with-master-data-v1/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/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/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-v1)\n\n[Querying documents in Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/querying-documents-in-master-data-v1)\n\n[Implementing newletter opt-in with Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1)\n\n[Uploading files to Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/uploading-files-to-master-data-v1)\n\n[Interacting with Master Data v1 through VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/interacting-with-master-data-v1-through-vtex-io-services)\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/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/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/implementing-newsletter-opt-in-with-master-data-v1/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/implementing-newsletter-opt-in-with-master-data-v1/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-v1)\n\n[Implementing newletter opt-in with Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1)\n\nSetting up Newsletter opt-in with Master Data v1\n\nLearn how to configure newsletter subscriptions with Master Data v1.\n\nIn this article, we will guide you through configuring **Master Data** to collect the email addresses of customers who wish to subscribe to your newsletter.\n\nNewsletter inclusion is a form that can be integrated into any page of your store website (except checkout), allowing you to capture the email addresses of customers who express an interest in receiving updates about your store. This registration is usually associated with a store promotion.\n\nIntegrating newsletter subscriptions with **Master Data** streamlines customer management since all the store's registered customers are already stored in Master Data.\n\n## Before you begin\n\n* Install the SafeData app in your VTEX account. SafeData provides a middleware for retrieving and storing Master Data (v1 e v2) information directly from the frontend. For more information, please refer to the [SafeData documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata).\n\n## Instructions\n\nBelow, we provide a step-by-step guide to assist you in setting up this configuration:\n\n1. Create the necessary fields in the CRM. This step is only necessary if you want an extra field in addition to those already in your CRM. If this is the case, please refer to the [Creating a field in Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/how-can-i-create-field-in-master-data) guide.\n2. Implement the fields in the HTML of the page determined by the store.\n\n> Please note that the `vtex.cmc:newsletterOptIn` control has been discontinued and should no longer be employed. Instead, use the HTML code created by your development team to achieve this functionality on the store's designated page.\n\n1. Send the information via SafeData API. The SafeData app provides endpoints similar to Master Data endpoints. Use the example request below to update a user profile and enable newsletter opt-in:\n\n**Method:** `PATCH`\n\n**Path:**\n\n`1\n\nhttps://{{accountName}}.vtexcommercestable.com.br/api/io/safedata/CL/documents/{{documentId}} \n\n`\n\n**Body:**\n\n`1\n\n{ \n\n2\n\n \"firstName\": \"Jonh\", \n\n3\n\n \"lastName\": \"Lennon\", \n\n4\n\n \"email\": \"jonh.lennon@lennon.com.br\", \n\n5\n\n \"isNewsletterOptIn\": true \n\n6\n\n} \n\n`\n\nBy following these steps and utilizing the SafeData API, you can efficiently manage and enhance your newsletter subscription process, keeping your customers engaged and informed. Your CRM will now reflect the email addresses of those who have opted to receive your newsletter.\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-v1/implementing-newsletter-opt-in-with-master-data-v1.md)\n\n[Querying documents in Master Data v1« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1//docs/guides/querying-documents-in-master-data-v1)[Uploading files to Master Data v1Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1//docs/guides/uploading-files-to-master-data-v1)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v1/implementing-newsletter-opt-in-with-master-data-v1.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/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1%23instructions)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_08cfc89a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides multilevel omnichannel inventory api integration in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory)\n\n[Multilevel omnichannel inventory API integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration)\n\n[Change chain orders in external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory)\n\n[Multilevel omnichannel inventory API integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration)\n\n[Change chain orders in external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides)\n\nLogistics\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory)\n\n[Multilevel omnichannel inventory API integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration)\n\nMultilevel omnichannel inventory API integration\n\n> The [Multilevel Omnichannel Inventory (MOI)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) feature has been discontinued for integrations with external marketplaces. Now, MOI is available only for integrations between VTEX marketplaces and sellers. We recommend reviewing your integration strategies to align with the currently supported functionalities. For more information, please contact [VTEX support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\nMarketplaces following the [External Marketplace protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide) can also make the [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) setting available for VTEX sellers connected to it. This allows for more fulfillment options by VTEX sellers, since they can connect their franchise accounts' inventories as fulfillment options. You can learn more about the benefits and restrictions of implementing this feature in our [Multilevel Omnichannel Inventory Help article](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4).\n\nExternal marketplaces and connectors should follow this article's instructions to configure Multilevel Omnichannel Inventory in their marketplace architecture with VTEX.\n\n> Before you begin, make sure that the necessary [settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory%23setup-for-vtex-marketplaces) are made in the connected VTEX account, so the feature is fully operational.\n\n## API integration overview\n\nWhen using a [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) architecture, the endpoints used in the integration's architecture are the following:\n\n* [Place Order](#place-multilevel-omnichannel-order): create the order in the seller responsible for fulfillment.\n* [Marketplace Order Authorization](#marketplace-order-authorization): progressing the order, after the marketplace's authorization.\n* [Cancel Order Notification](#cancel-order-notification): route to be notified of the seller's, or of the chain agent's (in this case seller level 2) cancellation.\n* [Order Invoice Notification](#order-invoice-notification): route to receive invoice notification from the seller, or of the chain agent's (in this case seller level 2).\n\nTherefore, the flow of the routes follows the image below:\n\n\n\n## Place Multilevel Omnichannel Order\n\nUse the request example below to Place Order.\n\n* Method: PUT\n* URL: `{host}/api/checkout/pvt/orders?sc={sc}&affiliateId={affiliateId}`\n\nRequest example:\n\n`1\n\n{ \n\n2\n\n \"items\":[ \n\n3\n\n { \n\n4\n\n \"id\":\"8\", \n\n5\n\n \"quantity\":1, \n\n6\n\n \"seller\":\"1\", \n\n7\n\n \"price\":12 \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"id\":\"36\", \n\n11\n\n \"quantity\":1, \n\n12\n\n \"seller\":\"1\", \n\n13\n\n \"price\":120 \n\n14\n\n } \n\n15\n\n ], \n\n16\n\n \"clientProfileData\":{ \n\n17\n\n \"email\":\"sicrano@mailinator.com\" \n\n18\n\n }, \n\n19\n\n \"shippingData\":{ \n\n20\n\n \"attachmentId\":\"shippingData\", \n\n21\n\n \"logisticsInfo\":[ \n\n22\n\n { \n\n23\n\n \"itemIndex\":0, \n\n24\n\n \"selectedSla\":\"Retirada (14b25e5)\", \n\n25\n\n \"selectedDeliveryChannel\":\"pickup-in-point\", \n\n26\n\n \"price\":0 \n\n27\n\n }, \n\n28\n\n { \n\n29\n\n \"itemIndex\":1, \n\n30\n\n \"selectedSla\":\"Normal\", \n\n31\n\n \"selectedDeliveryChannel\":\"delivery\", \n\n32\n\n \"price\":0 \n\n33\n\n } \n\n34\n\n ], \n\n35\n\n \"selectedAddresses\":[ \n\n36\n\n { \n\n37\n\n \"addressId\":\"-4581767308704\" \n\n38\n\n } \n\n39\n\n ] \n\n40\n\n }, \n\n41\n\n \"marketplacePaymentValue\":1550, \n\n42\n\n \"marketplaceOrderGroup\":\"externalMarketplace10\", \n\n43\n\n \"marketplaceServicesEndpoint\":\"http://service.externalmarketplace.com/api/orders?parameter=value\" \n\n44\n\n} \n\n`\n\n### Changes in the order's data\n\nThe Multilevel Omnichannel Inventory changes and adds fields to the order's data. You can know more about the fields in the [Retrieve user order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/userorderdetails) API Reference.\n\nThe table below describes the fields that were added or changed in the order's data.\n\n| Field | New or Changed? | Description |\n| --------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| sc | New | Path parameter including the sales channel ID. |\n| marketplaceServicesEndpoint | New | Field is added to the orderform. This field should be filled in with the information provided by the external marketplace that is placing an order in VTEX. |\n| marketplaceOrdergroup | New | Field is added to the orderform. This field should be filled in with the information provided by the external marketplace that is placing an order in VTEX. |\n| affiliateId | New | The [afiliate](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/o-que-e-afiliado--4bN3e1YarSEammk2yOeMc0) identification code created by the seller. The seller must inform this ID to the marketplace so that the marketplace can complete the configuration process. |\n| marketplacePaymentValue | New | Field is added to the orderform. |\n| transaction | Changed | This field no longer is required in the orderform. |\n| origin | Changed | The field 'origin' will come with chain as a value, and not fulfillment or marketplace like before. |\n| paymentData | Changed | The field is no longer required in chained orders. |\n\n## Marketplace Order Authorization\n\nThe marketplace must implement the following endpoint to notify the chain order that its progress has been approved:\n\n* Method: POST\n* URL: `{host}/api/checkout/pvt/orders/{orderId}/receipts/marketplace-order-authorization`\n\nRequest example\n\n`1\n\n{ \n\n2\n\n \"items\":[ \n\n3\n\n { \n\n4\n\n \"id\":\"8\", \n\n5\n\n \"quantity\":1, \n\n6\n\n \"seller\":\"1\", \n\n7\n\n \"price\":12 \n\n8\n\n }, \n\n9\n\n ], \n\n10\n\n \"marketplaceOrderGroup\": \"847392476\", \n\n11\n\n \"authorizationReceipt\": { \n\n12\n\n \"date\": \"{date}\", \n\n13\n\n \"receipt\": \"{receipt}\" \n\n14\n\n } \n\n15\n\n} \n\n`\n\n| Name | Type | Mandatory | Description |\n| --------------------- | ---------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| orderId | String | Yes | Path parameter with the Chain order ID. |\n| items | Array of objects | Yes | Array containing the SKUs that are being invoiced. |\n| id | String | Yes | ID of the SKU being invoiced. |\n| price | Integer | Yes | Total price of the SKU being invoiced in cents. Do not use any decimal separator. For instance, $24.99 should be represented as 2499. |\n| seller | String | Yes | Account name of the seller responsible for fulfillment |\n| quantity | Integer | Yes | Quantity currently in inventory of the SKU being invoiced. |\n| marketplaceOrderGroup | String | Yes | Marketplace order ID or order group |\n| authorizationReceipt | Object | Yes | Object including date and receipt of authorization |\n| date | String | Yes | Date of authorization |\n| receipt | String | Yes | Receipt number |\n\n## Cancel Order Notification\n\nThe marketplace must implement the endpoint below, to receive the cancel notification from the VTEX seller.\n\n* Method: POST\n* URL: `https://{baseUrldoParceiro}/pvt/orders/order-group/{orderGroup}/notifications/seller-cancellation`\n\n### Request example\n\n`1\n\n{ \n\n2\n\n \"id\":\"sellerOrderCancelled\", \n\n3\n\n \"sellerOrderId\": \"7908010136043\" \n\n4\n\n} \n\n`\n\n| Name | Type | Mandatory | Description |\n| ------------- | ------ | --------- | ----------------------------------------------------------------- |\n| orderGroup | String | Yes | Path parameter including the marketplace order ID or order group. |\n| id | String | Yes | ID of the canceled order by the seller. |\n| sellerOrderId | String | Yes | Order ID in the VTEX system. |\n\n## Order Invoice Notification\n\nThe marketplace must implement this endpoint for the chain order to inform it about the order invoice. Check out our [Order Invoice Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/invoice) to know more details.\n\n* Method: POST\n* URL: `{marketplaceServiceEndpoint}/api/oms/pvt/orders/{orderId}/invoice`\n\n> Note that the path including `/pvt` is usually called if the notification is meant for an internal VTEX endpoint. If calling external agents, substitute the path for `/pub`.\n\nRequest example:\n\n`1\n\n{ \n\n2\n\n \"invoiceNumber\":\"7999972\", \n\n3\n\n \"invoiceValue\":7450, \n\n4\n\n \"issuanceDate\":\"2019-02-07T02:00:00.000Z\", \n\n5\n\n \"invoiceUrl\":\"http://www.invoiceu.rl\", \n\n6\n\n \"invoiceKey\":\"799\", \n\n7\n\n \"trackingNumber\":\"9997LUX\", \n\n8\n\n \"trackingUrl\":\"http://www.trackingu.rl\", \n\n9\n\n \"courier\":\"All postal codes\", \n\n10\n\n \"items\": [ \n\n11\n\n { \n\n12\n\n \"id\": \"1231\", \n\n13\n\n \"price\": 7450, \n\n14\n\n \"quantity\": 1 \n\n15\n\n } \n\n16\n\n ] \n\n17\n\n} \n\n`\n\n| Name | Type | Mandatory | Description |\n| -------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| invoiceNumber | String | Yes | Number that identifies the invoice. |\n| invoiceValue | String | Yes | Total amount being invoiced in cents. Do not use any decimal separator. For instance, $24.99 should be represented as 2499. |\n| issuanceDate | String | Yes | Issuance date of the invoice. |\n| invoiceUrl | String | URL of the invoice. Can be used to send the URL of an XML file, for example, which is useful for some integrations. | |\n| trackingNumber | String | No | The number code that identifies the order tracking. This field should only be used when sending the tracking information. When the request is used for sending the invoice, this field should be left empty. |\n| trackingUrl | String | No | The URL used to track the order. This field should only be used when sending the tracking information. When the request is used for sending the invoice, this field should be left empty. |\n| courier | String | No | The name of the carrier responsible for delivering the order. This field should only be used when sending the tracking information. When the request is used for sending the invoice, this field should be left empty. |\n| items | Array of objects | Yes | Array containing the SKUs that are being invoiced. |\n| id | String | Yes | ID of the SKU being invoiced. |\n| price | Integer | Yes | Total price of the SKU being invoiced in cents. Do not use any decimal separator. For instance, $24.99 should be represented as 2499. |\n| quantity | Integer | Yes | Quantity currently in inventory of the SKU being invoiced. |\n\nResponse example:\n\n`1\n\n{ \n\n2\n\n \"date\": \"2018-11-21T11:50:09.9994509-02:00\", \n\n3\n\n \"orderId\": \"876053333998-01\", \n\n4\n\n \"receipt\": \"95233cf2078d418ba77155380c18f398\" \n\n5\n\n} \n\n`\n\n## Next steps\n\nCheckout the [Change chain orders in external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces) article to learn how to implement more complex change order scenarios.\n\nContributors\n\n2\n\n[](https://github.com/anabaarbosa)\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/Fulfillment/multilevel-omnichannel-inventory/multilevel-omnichannel-inventory-api-integration.md)\n\n[Multilevel Omnichannel Inventory« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration//docs/guides/multilevel-omnichannel-inventory)[Change chain orders in external marketplacesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration//docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)\n\nContributors\n\n2\n\n[](https://github.com/anabaarbosa)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[API integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23api-integration-overview)\n\n[Place Multilevel Omnichannel Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23place-multilevel-omnichannel-order)\n\n[Changes in the order's data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23changes-in-the-orders-data)\n\n[Marketplace Order Authorization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23marketplace-order-authorization)\n\n[Cancel Order Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23cancel-order-notification)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23request-example)\n\n[Order Invoice Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23order-invoice-notification)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23next-steps)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/multilevel-omnichannel-inventory/multilevel-omnichannel-inventory-api-integration.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[API integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23api-integration-overview)\n\n[Place Multilevel Omnichannel Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23place-multilevel-omnichannel-order)\n\n[Changes in the order's data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23changes-in-the-orders-data)\n\n[Marketplace Order Authorization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23marketplace-order-authorization)\n\n[Cancel Order Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23cancel-order-notification)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23request-example)\n\n[Order Invoice Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23order-invoice-notification)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23next-steps)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_590aa428
|
[
{
"role": "system",
"content": "You are a VTEX 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 react 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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-builder/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-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-react-builder/docs/guides/vtex-io-documentation-builders)\n\n[React Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder/docs/guides/vtex-io-documentation-react-builder)\n\nReact builder\n\nLearn how to use the VTEX IO React builder.\n\nThe `react` builder is used to develop apps with [React](https://read.calvincode.net/reader?url=https://react.dev/) when your project requires customized frontend solutions not covered by our native components.\n\nThis builder interprets the `/react` directory, where you must place the app’s React code using [Typescript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/). When you run your app, this code is transformed into compiled bundles, ready for use in frontend apps.\n\nTo learn how to implement apps using this builder, check our [Storefront apps guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io).\n\n## Folder structure\n\nAn app that uses the `react` builder has a folder named `/react` in its root directory. The directory structure may vary depending on the development preferences or specific project settings.\n\nThe basic structure of a React folder is composed of the following files, as you can see in the [React boilerplate app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/react-app-template/tree/master/react):\n\n`1\n\nreact \n\n2\n\n ┣ 📂 typings \n\n3\n\n ┣ 📄 {ReactCodeFileName}.tsx \n\n4\n\n ┣ 📄 package.json \n\n5\n\n ┣ 📄 tsconfig.json \n\n6\n\n ┗ 📄 yarn.lock \n\n`\n\n* `typings`: Folder holding TypeScript type definitions.\n* `.tsx` files: Contain the source code of React components. Replace `{ReactCodeFileName}` according to your scenario.\n* `tsconfig.json`: Specifies how the TypeScript compiler should behave, indicating the root directory and the output directory for the compiled code, among other project settings for TypeScript. Check the [tsconfig.json documentation](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) to learn more about this file.\n* `package.json`: Defines the project’s metadata, dependencies, and custom scripts using [Yarn](https://read.calvincode.net/reader?url=https://yarnpkg.com/migration/overview), and other configuration settings.\n* `yarn.lock`: Locks down the exact versions of your project’s dependencies, including transitive dependencies, to ensure consistent builds across different machines and environments. This file is automatically generated based on the dependencies in your `package.json` file.\n\n## Usage\n\nTo use the `react` builder, follow these steps:\n\n1. Clone the React [boilerplate app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/react-app-template/tree/master/react) to your local files.\n2. Modify the `manifest.json` file in the React example app to include your app’s metadata, such as its name, version, vendor, and dependencies. The `react` builder must also be declared in the app’s `manifest.json` file as follows: \n`1 \n\"builders\": { \n2 \n \"react\": \"3.x\" \n3 \n} \n`\n3. [Link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) to a development workspace.\n\nFor more information on how to create a React app using VTEX IO, see [Creating a new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app).\n\n> Learn how to link a React component to a Store Framework block in [store builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder).\n\n## Use case examples\n\nThe `react` builder is versatile and enables the development of frontend apps with different characteristics and objectives. The [default template](#understanding-the-apps-file-structure) provides only the essential files, but the possibilities are countless.\n\nBelow is an example of a React component and its folders and files within the `react` directory.\n\nThe [VTEX Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components) is a collection of components that can be used to create or extend other VTEX apps.\n\n> Note that an app using the `react` builder can export a single or multiple components.\n\nThis collection is composed by some components, such as [Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-availabilitysubscriber), [Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-buybutton), [SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-skuselector), [Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-searchbar), among others.\n\nThe app’s file structure includes folders and files that enable the use of the collection’s React components. You can check some of them below:\n\n`1\n\nreact \n\n2\n\n ┣ 📂 components \n\n3\n\n ┣ 📂 graphql \n\n4\n\n ┣ 📂 typings \n\n5\n\n ┣ 📂 utils \n\n6\n\n ┣ 📄 {FileName}.tsx \n\n7\n\n ┣ 📄 {FileName}.tsx \n\n8\n\n ┣ 📄 {FileName}.js \n\n9\n\n ┣ 📄 {FileName}.js \n\n10\n\n ┣ 📄 … \n\n11\n\n ┣ 📄 package.json \n\n12\n\n ┣ 📄 tsconfig.json \n\n13\n\n ┗ 📄 yarn.lock \n\n`\n\n* The `components` folder contains the folders of each React component.\n* The `graphql` folder contains GraphQL queries and mutations, which some components use to communicate with the backend. Keeping GraphQL code separate from other parts of the React component promotes modularity and facilitates the management of queries, mutations, or subscriptions specific to the React component.\n* The `utils` folder contains utility functions or helper modules used by some components.\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-react-builder.md)\n\n[Pixel Builder« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder//docs/guides/vtex-io-documentation-pixel-builder)[Store BuilderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder//docs/guides/vtex-io-documentation-store-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-react-builder/docs/guides/vtex-io-documentation-react-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder/docs/guides/vtex-io-documentation-react-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder/docs/guides/vtex-io-documentation-react-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-react-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-react-builder/docs/guides/vtex-io-documentation-react-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder/docs/guides/vtex-io-documentation-react-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder/docs/guides/vtex-io-documentation-react-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_3bd069bd
|
[
{
"role": "system",
"content": "You are a VTEX 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 purchase flows in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-purchase-flows/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-purchase-flows/docs/api-reference)\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-purchase-flows/docs/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-purchase-flows/docs/storefront-development)\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-purchase-flows/docs/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-purchase-flows/docs/troubleshooting)\n\n[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-purchase-flows/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/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-purchase-flows/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/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-purchase-flows/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/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-purchase-flows/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/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-purchase-flows/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/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-purchase-flows/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-purchase-flows/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-guide)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows)\n\nPurchase Flows\n\nA purchase flow (also known as shopping flow) represents the steps or actions a customer takes in order to complete payment for a purchase. In VTEX, the available purchase flows are:\n\n* Transparent\n* Redirect\n* Payment App\n\n## Transparent\n\nThe Transparent purchase flow is used when customers fill in payment information in the standard SmartCheckout template and complete the purchase without leaving the store. This is the most common option if you want to provide a seamless payment experience.\n\n## Redirect\n\nThe Redirect purchase flow is used when customers confirm the payment option in the store and are then redirected to a different page to fill in payment information and complete the purchase.\n\nThis option is used when the partner needs a specific interaction with the customer that is not provided by the standard SmartCheckout template.\n\nSome examples include: displaying a QR code for payment, filling in an application form, logging in to an external website.\n\n> For the connector that will use Redirect, there is no need to pass all the Test Suit tests, only the Redirect one.\n\n\n\nThe sequence of events in a Redirect payment flow occurs as described in the following steps: \n1. The customer clicks on **Finish Payment** in the Checkout.\n2. Checkout calls the Gateway with a [Start Transaction request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/1createanewtransaction).\n3. Gateway calls the provider with an [Authorization request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/4doauthorization) (POST `/payments`).\n4. Provider returns in the response body of the Authorization request the status `undefined` and the `paymentURL`.\n5. Checkout redirects the customer to the `paymentURL` webpage.\n6. On the `paymentURL` webpage, the customer interacts with the provider's interface.\n7. Provider captures the input of customer interaction.\n8. Provider [responds](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/createpayment%23callbacks) to `callbackURL` with final authorization status (`approved` or `denied`).\n9. Provider redirects the customer to the `returnURL` webpage.\n\n> The content of the `paymentURL` parameter has to include the complete URL to properly redirect the customer to the desired webpage, including the endpoint path and a code to that specific payment (e.g.: `http://php-connector.herokuapp.com/installments.php?paymentId=7ee64e51-a0d3-4405-874c-d7497ab84572`)\n\n## Payment App\n\nThe Payment App purchase flow is a flexible option used to allow customers to go through a custom payment experience without leaving the store.\n\nThis model applies to a large variety of payment methods thanks to its interaction with the Checkout API. However, Payment Apps must be developed and deployed using [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io). For more information, check our [Payment App guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-payment-app).\n\n## Operations in the payment flow\n\nThe following operations define the patterns of interaction between the Payment Provider and the VTEX Payments Gateway:\n\n* Authorization\n* Cancellation or Refund\n* Settlement\n\nWhen a customer completes a purchase, this triggers the creation of a new payment request, starting with the Authorization operation.\n\n### Authorization\n\nAs soon as the purchase is complete, the Payments Gateway sends a [POST Create Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/createpayment) request to the provider.\n\nThe payload is quite big, as it contains information such as the items in the cart, billing address, the order ID, payment methods, callbackURL, and others. More information about the endpoints and their payloads will be available in the [Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider) article.\n\nAfter that, the provider should respond to the request. If the payment cannot be processed right the way, the transaction status changes to `undefined`. That does not mean that the payment was canceled or denied, it is just being evaluated.\n\nThe system can retry the call asynchronously for seven days until the payment is indeed processed. During this period, VTEX will assume that the payment is “pending\".\n\nTo break this cycle of asynchronous retries, there are two possible flows depending if the integration uses VTEX IO infrastructure or not:\n\n* **Without VTEX IO (developed in the partner's infrastructure)**: when the provider gets an updated payment status, it will use a **notification** endpoint from the `callbackURL` parameter to change the payment status in the Gateway to `authorized` or `denied`. Both responses end the authorization flow.\n* **With VTEX IO**: when the provider gets an updated payment status, it will read the `callbackURL` parameter to call a **retry** endpoint. Then, the Gateway makes another Create Payment request to obtain the new status defined by the provider, which will be `authorized` or `denied`. Both responses end the authorization flow.\n\n#### Callback URL\n\nThe `callbackUrl` field contains a URL that the payment provider uses to make a callback and inform our gateway of the final payment status: `approved` or `denied`.\n\nThis URL has some query parameters, including the `X-VTEX-signature`. This parameter is mandatory and contains a signature token to identify that the request has been generated from VTEX as a security measure. The signature token has at most 32 characters. You can check an example of callback URL with the signature token below:\n\n`1\n\nhttps://gatewayqa.vtexpayments.com.br/api/pvt/payment-provider/transactions/8FB0F111111122222333344449984ACB/payments/A2A9A25B11111111222222333327883C/callback?accountName=teampaymentsintegrations&X-VTEX-signature=R123456789aBcDeFGHij1234567890tk \n\n`\n\nIn the [Transactions page of the Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-view-the-orders-details--tutorials%5F452), the signature token appears masked for security reasons, as in this example: `X-VTEX-signature=Rj******tk`.\n\nWhen making the callback request, we recommend that payment providers use the callback URL exactly as received, which guarantees that all the parameters are included.\n\n#### Mode-off\n\nMode-off status is a native reliability feature that allows VTEX to track the payment health and stability of their partners, ensuring that the system will not cancel orders due to instabilities.\n\nWhen VTEX identifies consecutive errors in its payment partners’ integrations — more than five errors over the last five minutes — the mode-off status is activated to handle credit card transactions.\n\nWhile the mode-off status is activated, all transactions that allow an asynchronous flow will be retained. During this period, the transaction remains in `authorizing` status.\n\nThis process takes an average of two hours and can hold up to two thousand requests. If the provider’s system returns to stability, the mode-off status is deactivated and our system will run processing reattempts for the transactions on standby.\n\nFor more information and frequently asked questions, refer to the [Mode-Off: FAQ](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/mode-off-faq--6hbd7PuvoxuRbPCvTqjxeB) article in our Help Center.\n\n### Cancellation or refund\n\nThe cancellation flow starts if the order is canceled for any reason. When an order is canceled, it activates the process to cancel the order’s payment as well.\n\nIn this case, there are two scenarios:\n\n* The payment was approved and already settled.\n* The payment was not approved.\n\n#### Payment approved and settled\n\nWhen a payment is approved and already settled but canceled after that, VTEX makes the call [POST Refund Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/refunds) to the payment provider. Also, the Payment Provider Protocol accepts partial refunds when necessary.\n\nRegardless of the provider's response, VTEX will end the transaction with the status `canceled`.\n\n#### Payment approved but not settled\n\nWhen a payment is approved but canceled before being settled, VTEX makes the call [POST Cancel Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/cancellations) to the payment provider.\n\nRegardless of the provider's response, VTEX will end the transaction with the status `canceled`.\n\n#### Payment not approved\n\nVTEX sends the [POST Cancel Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/cancellations) request to the payment provider once there is no need to refund a payment that was not settled.\n\nIf the provider does not authorize the payment cancellation and returns a response with an `undefined` status, the flow will run asynchronously for a day. If the provider does not respond after this period, the payment will be canceled.\n\n### Settlement\n\nOnce the gateway authorizes the payment, VTEX sends the [POST Settle Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/settlements) request to the provider. If the provider does not authorize the settlement right the way, the request will keep running asynchronously for a day.\n\nDuring this period, when the provider responds to the call authorizing the settlement, VTEX’s platform changes the transaction status to `finished` and completes the flow.\n\nIf after one day of retries the request fails, the payment will be canceled.\n\n## Communication in the payment flow\n\nWhen using synchronous communication, VTEX will communicate with the payment provider during the purchase flow and this will determine whether the payment was approved or not.\n\nWhen using asynchronous communication, VTEX will wait for a longer period of time for approval from the payment provider. This is the case of bank invoice (boleto bancário/Brazil), for example, where the shopper is expected to have a few days to pay for their order through their bank.\n\nDepending on the payment method selected, three endpoints in the payment flow might use synchronous or asynchronous communication:\n\n* [POST Create Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments)\n* [POST Cancel Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/cancellations)\n* [POST Settle Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/settlements)\n\nSince the selection of payment method depends on the customer, **your provider must be prepared to receive multiple repeated requests** in those endpoints.\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/payments-integration-guide/payments-integration-purchase-flows.md)\n\n[Payment Provider Framework« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows//docs/guides/payments-integration-payment-provider-framework)[Payment AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows//docs/guides/payments-integration-payment-app)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Transparent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23transparent)\n\n[Redirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23redirect)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23payment-app)\n\n[Operations in the payment flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23operations-in-the-payment-flow)\n\n[Authorization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23authorization)[Cancellation or refund](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23cancellation-or-refund)[Settlement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23settlement)\n\n[Communication in the payment flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23communication-in-the-payment-flow)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-purchase-flows.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Transparent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23transparent)\n\n[Redirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23redirect)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23payment-app)\n\n[Operations in the payment flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23operations-in-the-payment-flow)\n\n[Authorization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23authorization)[Cancellation or refund](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23cancellation-or-refund)[Settlement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23settlement)\n\n[Communication in the payment flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows/docs/guides/payments-integration-purchase-flows%23communication-in-the-payment-flow)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_61fecd62
|
[
{
"role": "system",
"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 yotpo 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.yotpo/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/api-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.yotpo/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.yotpo/docs/storefront-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.yotpo/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.yotpo/docs/troubleshooting)\n\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.yotpo/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/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.yotpo/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.yotpo/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/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.yotpo/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.yotpo/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.yotpo/docs/vtex-io-apps)\n\nYotpo Reviews Integration\n\nOfficial extension\n\nVersion: 1.2.1\n\nLatest version: 1.2.1\n\nThe Yotpo Reviews Integration app is a product review and rating integration with [Yotpo](https://read.calvincode.net/reader?url=https://www.yotpo.com/).\n\n\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store/installing-an-app) the `yotpo` app in the desired account;\n2. In the admin's account, access **Apps** and then select the **Yotpo Integration** box;\n\n\n\n1. Once in the app's page, define the app’s configurations in the **setup** section:\n\n\n\n* **Yotpo App Key**: Enter the app key that you have received from Yotpo's admin interface.\n* **Use Reference Id**: Check this box if you wish to use the product's reference id rather than its product id to link the product to its reviews.\n\n:warning: This app fills the standard VTEX review blocks with content using abstract interfaces from `vtex.product-review-interfaces` . The **VTEX review blocks** are:\n\n* `\"product-reviews\"`: This block can be added to the product page (`store.product`). It renders the main Yotpo widget which lists any reviews or answered questions for the product being viewed as well as a form to add a new review or ask a new question.\n* `\"product-rating-summary\"`: This block can be added to the product page (`store.product`) and renders the average rating for the product being viewed as well as the number of reviews that have been submitted.\n* `\"product-rating-inline\"`: Similar to the previous block, but intended to be used in product shelves.\n\nAdditional **Yotpo review blocks** are:\n\n* `\"yotpo-all-reviews\"`: This block can be added to a custom page (`store.custom`). It allows you to display all your site and product reviews in one page by rendering a [Yotpo widget](https://read.calvincode.net/reader?url=https://support.yotpo.com/en/article/generic-other-platforms-adding-yotpo-reviews-to-a-dedicated-page).\n\nThis app also includes a pixel integration to send order conversation tracking data to Yotpo.\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ---------------------- |\n| reviewsContainer |\n| ratingSummaryContainer |\n| ratingInlineContainer |\n| allReviewsContainer |\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.yotpo/docs/apps/vtex.yotpo%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.yotpo/docs/apps/vtex.yotpo%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_4219a319
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides working with weni by vtex agents in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/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/working-with-weni-by-vtex-agents/docs/guides)\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents)\n\nWorking with Weni by VTEX agents\n\nLearn how to create, configure, and deploy agents using the Weni by VTEX CLI, with some examples of agents.\n\nLearn how to create, configure, and deploy AI agents using Weni by VTEX CLI.\n\n## Agent Definition File\n\nAgents are defined using YAML files. Here's the basic structure:\n\n`1\n\nagents: \n\n2\n\n agent_id: \n\n3\n\n name: \"Agent Name\" \n\n4\n\n description: \"Agent Description\" \n\n5\n\n instructions: \n\n6\n\n - \"Instruction 1\" \n\n7\n\n - \"Instruction 2\" \n\n8\n\n guardrails: \n\n9\n\n - \"Guardrail 1\" \n\n10\n\n tools: \n\n11\n\n - tool_name: \n\n12\n\n name: \"Tool Name\" \n\n13\n\n source: \n\n14\n\n path: \"tools/tool_name\" \n\n15\n\n entrypoint: \"main.ToolClass\" \n\n16\n\n description: \"Tool Description\" \n\n17\n\n parameters: \n\n18\n\n - param_name: \n\n19\n\n description: \"Parameter Description\" \n\n20\n\n type: \"string\" \n\n21\n\n required: true \n\n22\n\n contact_field: true \n\n`\n\n### Key Components\n\n1. **Agent ID** \n * Unique identifier for your agent \n * Used internally by the system\n2. **Basic Information** \n * `name`: Display name (max 55 characters) \n * `description`: Brief description of the agent's purpose\n3. **Instructions** \n * Guide the agent's behavior \n * Minimum 40 characters each \n * Should be clear and specific\n4. **Guardrails** \n * Define boundaries and limitations \n * Prevent unwanted behavior\n5. **Tools** \n * Custom functionalities \n * Implemented as Python classes using the Weni by VTEX SDK\n\n### Tool Source Configuration\n\nThe `source` field is critical for locating and executing your tool:\n\n`1\n\nsource: \n\n2\n\n path: \"tools/tool_name\" \n\n3\n\n entrypoint: \"main.ToolClass\" \n\n`\n\n* **path**: Points to the directory containing your tool implementation \n * Example: `tools/get_address` refers to a folder named `get_address` inside a `tools` directory \n * This folder should contain your Python modules and requirements.txt\n* **entrypoint**: Specifies which class to use in which file \n * Format: `filename.ClassName` \n * Example: `main.GetAddress` means: \n * Look for a file named `main.py` in the path directory \n * Find a class named `GetAddress` inside that file \n * This class must inherit from the `Tool` class\n\nYour directory structure should look like:\n\n`1\n\nproject/ \n\n2\n\n├── agents.yaml \n\n3\n\n└── tools/ \n\n4\n\n └── get_address/ \n\n5\n\n ├── main.py # Contains GetAddress class \n\n6\n\n └── requirements.txt # Dependencies \n\n`\n\n## Creating Tools\n\n### Tool Implementation Structure\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\n \n5\n\nclass ToolName(Tool): \n\n6\n\n def execute(self, context: Context) -> TextResponse: \n\n7\n\n # Extract parameters \n\n8\n\n parameters = context.parameters \n\n9\n\n param_value = parameters.get(\"param_name\", \"\") \n\n10\n\n \n11\n\n # Process the request \n\n12\n\n result = self.process_request(param_value) \n\n13\n\n \n14\n\n # Return response \n\n15\n\n return TextResponse(data=result) \n\n16\n\n \n17\n\n def process_request(self, param_value): \n\n18\n\n # Your business logic here \n\n19\n\n return {\"key\": \"value\"} \n\n`\n\n#### Important Requirements\n\n* The class **must** inherit from `Tool`\n* The class **must** implement the `execute` method\n* The class name **must** match the class name in your entrypoint\n\n## Deploying Agents\n\n### Push Command\n\nDeploy your agent using:\n\n`1\n\nweni project push agents.yaml \n\n`\n\nThe command:\n\n1. Validates your YAML\n2. Uploads tools\n3. Creates/updates the agent\n\n### Deployment Best Practices\n\n1. **Version Control** \n * Keep agent definitions in version control \n * Document changes\n2. **Testing** \n * Test locally when possible \n * Start with staging environment \n * Verify all tools work\n3. **Organization** \n * Use clear file names \n * Keep related files together \n * Document dependencies\n\n## Advanced Topics\n\n### Parameter Types\n\nAvailable parameter types:\n\n* `string`\n* `number`\n* `integer`\n* `boolean`\n* `array`\n\n### Response Formats\n\nTools can return:\n\n* Text responses via `TextResponse`\n* Structured data\n* Error messages\n\n### Error Handling\n\nYour tools should:\n\n* Validate inputs\n* Handle exceptions gracefully\n* Return meaningful error messages\n\n## Troubleshooting\n\n### Common Issues\n\n1. **Deployment Failures** \n * Check YAML syntax \n * Verify tool paths \n * Confirm project selection\n2. **Tool Errors** \n * Verify tool entrypoint (class name) \n * Test tool class locally \n * Check parameter handling in context \n * Verify API endpoints\n3. **Agent Behavior** \n * Review instructions \n * Check guardrails \n * Test with various inputs\n\n### Best Practices\n\n1. **Development Flow** \n * Develop locally \n * Test in staging \n * Deploy to production\n2. **Monitoring** \n * Keep deployment logs \n * Monitor tool performance \n * Track user interactions\n3. **Updates** \n * Plan changes carefully \n * Test updates thoroughly \n * Document modifications\n\n# Agent Examples\n\nHere are some examples of agents you can use.\n\n* [Book Agent](#book-agent): Searches for book information, including title, author, description, and other details.\n* [CEP Agent](#cep-agent): Provides an address based on its Brazilian postal code.\n* [Movie Agent](#movie-agent): Searches for movie information, with automatic translation of titles and descriptions.\n* [News Agent](#news-agent): Retrieves up-to-date news about various topics through a news API.\n\n## Book Agent\n\nThis example shows how to create an agent that provides detailed information about books based on the title provided by the user.\n\n### Agent Definition\n\nCreate a file called `agent_definition.yaml`:\n\n`1\n\nagents: \n\n2\n\n book_agent: \n\n3\n\n name: \"Book Agent\" \n\n4\n\n description: \"Expert in searching for book information\" \n\n5\n\n instructions: \n\n6\n\n - \"You are an expert in searching for detailed information about books\" \n\n7\n\n - \"When the user asks about a book, you should search and present the most relevant information\" \n\n8\n\n - \"The API returns information in English, and you should translate the description to Portuguese naturally and fluently\" \n\n9\n\n - \"If you can't find the book, suggest similar titles\" \n\n10\n\n - \"When translating the description, maintain the tone and style of the original text, adapting only to Brazilian Portuguese\" \n\n11\n\n - \"Provide information about authors, publisher, publication date, page count, and ratings when available\" \n\n12\n\n - \"You must translate the book description to Portuguese before presenting it to the user\" \n\n13\n\n guardrails: \n\n14\n\n - \"Maintain a professional and informative tone when presenting books\" \n\n15\n\n - \"Don't make assumptions about book content\" \n\n16\n\n - \"Provide accurate and verified information\" \n\n17\n\n - \"When translating, maintain fidelity to the original text meaning\" \n\n18\n\n - \"Mention when rating or page count information is not available\" \n\n19\n\n tools: \n\n20\n\n - get_books: \n\n21\n\n name: \"Search Books\" \n\n22\n\n source: \n\n23\n\n path: \"tools/get_books\" \n\n24\n\n entrypoint: \"books.GetBooks\" \n\n25\n\n path_test: \"test_definition.yaml\" \n\n26\n\n description: \"Function to search for book information\" \n\n27\n\n parameters: \n\n28\n\n - book_title: \n\n29\n\n description: \"book title to search for\" \n\n30\n\n type: \"string\" \n\n31\n\n required: true \n\n32\n\n contact_field: true \n\n`\n\n### Tool Implementation\n\nCreate a file `tools/get_books/books.py`:\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\nfrom datetime import datetime \n\n6\n\n \n7\n\n \n8\n\nclass GetBooks(Tool): \n\n9\n\n def execute(self, context: Context) -> TextResponse: \n\n10\n\n apiKey = context.credentials.get(\"apiKey\") \n\n11\n\n \n12\n\n book_title = context.parameters.get(\"book_title\", \"\") \n\n13\n\n books_response = self.get_books_by_title(title=book_title) \n\n14\n\n \n15\n\n # Format the response \n\n16\n\n items = books_response.get(\"items\", []) \n\n17\n\n if not items: \n\n18\n\n return TextResponse(data=\"Sorry, I couldn't find information about this book.\") \n\n19\n\n \n20\n\n response_data = { \n\n21\n\n \"status\": \"success\", \n\n22\n\n \"totalResults\": len(items[:5]), \n\n23\n\n \"books\": [] \n\n24\n\n } \n\n25\n\n \n26\n\n for book in items[:5]: \n\n27\n\n volume_info = book.get(\"volumeInfo\", {}) \n\n28\n\n book_data = { \n\n29\n\n \"id\": book.get(\"id\"), \n\n30\n\n \"title\": volume_info.get(\"title\"), \n\n31\n\n \"authors\": volume_info.get(\"authors\", []), \n\n32\n\n \"publisher\": volume_info.get(\"publisher\"), \n\n33\n\n \"publishedDate\": volume_info.get(\"publishedDate\"), \n\n34\n\n \"description\": volume_info.get(\"description\", \"\"), \n\n35\n\n \"pageCount\": volume_info.get(\"pageCount\"), \n\n36\n\n \"categories\": volume_info.get(\"categories\", []), \n\n37\n\n \"averageRating\": volume_info.get(\"averageRating\"), \n\n38\n\n \"ratingsCount\": volume_info.get(\"ratingsCount\"), \n\n39\n\n \"imageLinks\": volume_info.get(\"imageLinks\", {}), \n\n40\n\n \"language\": volume_info.get(\"language\"), \n\n41\n\n \"previewLink\": volume_info.get(\"previewLink\"), \n\n42\n\n \"infoLink\": volume_info.get(\"infoLink\") \n\n43\n\n } \n\n44\n\n response_data[\"books\"].append(book_data) \n\n45\n\n \n46\n\n return TextResponse(data=response_data) \n\n47\n\n \n48\n\n def get_books_by_title(self, title): \n\n49\n\n url = \"https://www.googleapis.com/books/v1/volumes\" \n\n50\n\n params = { \n\n51\n\n \"q\": title \n\n52\n\n } \n\n53\n\n response = requests.get(url, params=params) \n\n54\n\n return response.json() \n\n`\n\nCreate a file `tools/get_books/requirements.txt`:\n\n`1\n\nrequests==2.32.3 \n\n`\n\nCreate a file `tools/get_books/test_definition.yaml`:\n\n`1\n\ntests: \n\n2\n\n test_1: \n\n3\n\n parameters: \n\n4\n\n book_title: \"The Hobbit\" \n\n`\n\n### Testing the Tool Locally\n\nBefore deploying your agent, you can test the tool locally using the `weni run` command. This allows you to verify that your tool works correctly and debug any issues.\n\nTo test the Book Agent tool:\n\n`1\n\nweni run agent_definition.yaml book_agent get_books \n\n`\n\nThis command will execute the tests defined in the `test_definition.yaml` file and show you the output. You should see the book information for \"The Hobbit\" test case.\n\nIf you need more detailed logs for debugging, you can add the `-v` flag:\n\n`1\n\nweni run agent_definition.yaml book_agent get_books -v \n\n`\n\nThe verbose output will show you more details about the execution process, helping you identify and fix any issues with your tool.\n\n### Deployment Steps\n\n1. Deploy the agent:\n\n`1\n\n weni project push agent_definition.yaml \n\n`\n\n### Testing\n\nAfter deployment, you can test the agent:\n\n1. Open your project in the Weni by VTEX platform\n2. Find the Book Agent in your agents list\n3. Start a conversation\n4. Send a book title (e.g., \"Pride and Prejudice\" or \"Harry Potter\")\n\nThe agent will respond with detailed information about the book, including title, authors, publisher, publication date, page count, and ratings when available. The book description will be automatically translated to Portuguese.\n\n## CEP Agent\n\nThis example shows how to create an agent that can provide address information based on Brazilian postal codes (CEP).\n\n### Agent Definition\n\nCreate a file named `agents.yaml`:\n\n`1\n\nagents: \n\n2\n\n sample_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### Tool Implementation\n\nCreate a file `tools/get_address/main.py`:\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\n \n7\n\nclass GetAddress(Tool): \n\n8\n\n def execute(self, context: Context) -> TextResponse: \n\n9\n\n cep = context.parameters.get(\"cep\", \"\") \n\n10\n\n address_response = self.get_address_by_cep(cep=cep) \n\n11\n\n return TextResponse(data=address_response) \n\n12\n\n \n13\n\n def get_address_by_cep(self, cep): \n\n14\n\n url = f\"https://viacep.com.br/ws/{cep}/json/\" \n\n15\n\n response = requests.get(url) \n\n16\n\n return response.json() \n\n`\n\nCreate a file `tools/get_address/requirements.txt`:\n\n`1\n\nrequests==2.31.0 \n\n`\n\nCreate a file `tools/get_address/test_definition.yaml`:\n\n`1\n\ntests: \n\n2\n\n test_1: \n\n3\n\n parameters: \n\n4\n\n cep: \"01311-000\" \n\n5\n\n test_2: \n\n6\n\n parameters: \n\n7\n\n cep: \"70150-900\" \n\n8\n\n test_3: \n\n9\n\n parameters: \n\n10\n\n cep: \"20050-090\" \n\n`\n\n### Testing the Tool Locally\n\nBefore deploying your agent, you can test the tool locally using the `weni run` command. This allows you to verify that your tool works correctly and debug any issues.\n\nTo test the CEP Agent tool:\n\n`1\n\nweni run agent_definition.yaml cep_agent get_address \n\n`\n\nThis command will execute the tests defined in the `test_definition.yaml` file and show you the output. You should see the address information for the Brazilian postal codes specified in the test cases.\n\nIf you need more detailed logs for debugging, you can add the `-v` flag:\n\n`1\n\nweni run agent_definition.yaml cep_agent get_address -v \n\n`\n\nThis will run the test cases defined in `test_definition.yaml` and show you the output, helping you identify and fix any issues with your tool.\n\n### Deployment Steps\n\n1. Deploy the agent:\n\n`1\n\n weni project push agents.yaml \n\n`\n\n### Testing\n\nAfter deployment, you can test the agent by:\n\n1. Opening your project in the Weni by VTEX platform\n2. Finding the CEP Agent in your agents list\n3. Starting a conversation\n4. Sending a valid Brazilian postal code (e.g., \"01311-000\")\n\n## Movie Agent\n\nThis example shows how to create an agent that provides detailed information about movies, including title, synopsis, cast, ratings, and other relevant data.\n\n### Agent Definition\n\nCreate a file called `agent_definition.yaml`:\n\n`1\n\nagents: \n\n2\n\n movie_agent: \n\n3\n\n credentials: \n\n4\n\n movies_api_key: \n\n5\n\n label: \"api movies\" \n\n6\n\n placeholder: \"movies_api_key\" \n\n7\n\n name: \"Movie Agent\" \n\n8\n\n description: \"Expert in searching for movie information\" \n\n9\n\n instructions: \n\n10\n\n - \"You are an expert in searching for detailed information about movies\" \n\n11\n\n - \"When the user asks about a movie, you should search and present the most relevant information\" \n\n12\n\n - \"If the user provides the movie title in Portuguese, you should translate it to English before searching\" \n\n13\n\n - \"The API returns information in English, and you should translate the overview to Portuguese naturally and fluently\" \n\n14\n\n - \"Keep original titles in English, but you can provide an informal translation in parentheses when relevant\" \n\n15\n\n - \"If you can't find the movie, suggest similar titles\" \n\n16\n\n - \"Remember that the search must be done in English, even if the user asks in Portuguese\" \n\n17\n\n - \"When translating the overview, maintain the tone and style of the original text, adapting only to Brazilian Portuguese\" \n\n18\n\n - \"When translating the movie title to English, use the most common and internationally recognizable name\" \n\n19\n\n guardrails: \n\n20\n\n - \"Maintain a professional and informative tone when presenting movies\" \n\n21\n\n - \"Don't make assumptions about movie content\" \n\n22\n\n - \"Provide accurate and verified information\" \n\n23\n\n - \"When translating, maintain fidelity to the original text meaning\" \n\n24\n\n - \"If there's doubt in title translation, use the most internationally known name\" \n\n25\n\n tools: \n\n26\n\n - get_movies: \n\n27\n\n name: \"Get Movies\" \n\n28\n\n source: \n\n29\n\n path: \"tools/get_movies\" \n\n30\n\n entrypoint: \"main.GetMovies\" \n\n31\n\n path_test: \"test_definition.yaml\" \n\n32\n\n description: \"Function to get movie information from TMDB API\" \n\n33\n\n parameters: \n\n34\n\n - movie_title: \n\n35\n\n description: \"movie title to search for (will be translated to English if in Portuguese)\" \n\n36\n\n type: \"string\" \n\n37\n\n required: true \n\n38\n\n contact_field: true \n\n`\n\n### Tool Implementation\n\nCreate a file `tools/get_movies/main.py`:\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\nfrom datetime import datetime \n\n6\n\n \n7\n\nclass GetMovies(Tool): \n\n8\n\n def execute(self, context: Context) -> TextResponse: \n\n9\n\n movie_title = context.parameters.get(\"movie_title\", \"\") \n\n10\n\n api_key = context.credentials.get(\"movies_api_key\") \n\n11\n\n \n12\n\n # Search for movies by title \n\n13\n\n movies_response = self.search_movies_by_title(title=movie_title, api_key=api_key) \n\n14\n\n \n15\n\n # Format the response \n\n16\n\n results = movies_response.get(\"results\", []) \n\n17\n\n if not results: \n\n18\n\n return TextResponse(data=\"Sorry, I couldn't find information about this movie.\") \n\n19\n\n \n20\n\n # Get the first (most relevant) movie \n\n21\n\n movie_id = results[0].get(\"id\") \n\n22\n\n \n23\n\n # Get detailed information about the movie \n\n24\n\n movie_details = self.get_movie_details(movie_id=movie_id, api_key=api_key) \n\n25\n\n \n26\n\n response_data = { \n\n27\n\n \"id\": movie_details.get(\"id\"), \n\n28\n\n \"title\": movie_details.get(\"title\"), \n\n29\n\n \"original_title\": movie_details.get(\"original_title\"), \n\n30\n\n \"tagline\": movie_details.get(\"tagline\"), \n\n31\n\n \"overview\": movie_details.get(\"overview\"), \n\n32\n\n \"release_date\": movie_details.get(\"release_date\"), \n\n33\n\n \"runtime\": movie_details.get(\"runtime\"), \n\n34\n\n \"vote_average\": movie_details.get(\"vote_average\"), \n\n35\n\n \"vote_count\": movie_details.get(\"vote_count\"), \n\n36\n\n \"genres\": movie_details.get(\"genres\", []), \n\n37\n\n \"poster_path\": f\"https://image.tmdb.org/t/p/w500{movie_details.get('poster_path')}\" if movie_details.get(\"poster_path\") else None, \n\n38\n\n \"backdrop_path\": f\"https://image.tmdb.org/t/p/original{movie_details.get('backdrop_path')}\" if movie_details.get(\"backdrop_path\") else None \n\n39\n\n } \n\n40\n\n \n41\n\n return TextResponse(data=response_data) \n\n42\n\n \n43\n\n def search_movies_by_title(self, title, api_key): \n\n44\n\n url = \"https://api.themoviedb.org/3/search/movie\" \n\n45\n\n params = { \n\n46\n\n \"api_key\": api_key, \n\n47\n\n \"query\": title, \n\n48\n\n \"language\": \"en-US\", \n\n49\n\n \"page\": 1 \n\n50\n\n } \n\n51\n\n response = requests.get(url, params=params) \n\n52\n\n return response.json() \n\n53\n\n \n54\n\n def get_movie_details(self, movie_id, api_key): \n\n55\n\n url = f\"https://api.themoviedb.org/3/movie/{movie_id}\" \n\n56\n\n params = { \n\n57\n\n \"api_key\": api_key, \n\n58\n\n \"language\": \"en-US\", \n\n59\n\n \"append_to_response\": \"credits,similar\" \n\n60\n\n } \n\n61\n\n response = requests.get(url, params=params) \n\n62\n\n return response.json() \n\n`\n\nCreate a file `tools/get_movies/requirements.txt`:\n\n`1\n\nrequests==2.32.3 \n\n`\n\nCreate a file `tools/get_movies/test_definition.yaml`:\n\n`1\n\ntests: \n\n2\n\n test_1: \n\n3\n\n credentials: \n\n4\n\n movies_api_key: \"your_api_key_here\" \n\n5\n\n parameters: \n\n6\n\n movie_title: \"The Matrix\" \n\n`\n\n### Getting Credentials\n\nFor this agent to work properly, you'll need to get an API key from The Movie Database (TMDB):\n\n1. Visit the [TMDB](https://read.calvincode.net/reader?url=https://www.themoviedb.org/) website\n2. Register for a free account\n3. Access the API section in your account and request an API key\n4. Copy your API key\n5. When deploying the agent, you'll need to provide this key as a credential\n\n### Testing the Tool Locally\n\nBefore deploying your agent, you can test the tool locally using the `weni run` command. This allows you to verify that your tool works correctly and debug any issues.\n\nSince this tool requires credentials, create a `.env` file in the tool folder with your TMDB API key (e.g., `tools/get_movies/.env`):\n\n`1\n\nmovies_api_key=your_actual_tmdb_api_key_here \n\n`\n\nTo test the Movie Agent tool:\n\n`1\n\nweni run agent_definition.yaml movie_agent get_movies \n\n`\n\nThis command will execute the tests defined in the `test_definition.yaml` file and show you the output. The CLI will automatically pick up the credentials from the tool folder `.env` file and make them available to your tool during execution.\n\nIf you need more detailed logs for debugging, you can add the `-v` flag:\n\n`1\n\nweni run agent_definition.yaml movie_agent get_movies -v \n\n`\n\nThe verbose output will show you more details about the execution process, including API requests and responses, helping you identify and fix any issues with your tool.\n\n### Deployment Steps\n\n1. Deploy the agent:\n\n`1\n\n weni project push agent_definition.yaml \n\n`\n\n### Testing\n\nAfter deployment, you can test the agent:\n\n1. Open your project in the Weni by VTEX platform\n2. Find the Movie Agent in your agents list\n3. Provide the TMDB API key in the credential settings\n4. Start a conversation\n5. Send a movie title in Portuguese or English (e.g., \"The Godfather\" or \"Pulp Fiction\")\n\nThe agent will respond with detailed information about the movie, including title, synopsis (translated to Portuguese), release date, runtime, genres, ratings, and links to posters. If the title is provided in Portuguese, the agent will automatically translate it to perform the search.\n\n## News Agent\n\nThis example shows how to create an agent that provides up-to-date news on various topics through a news API.\n\n### Agent Definition\n\nCreate a file called `agent_definition.yaml`:\n\n`1\n\nagents: \n\n2\n\n news_agent: \n\n3\n\n credentials: \n\n4\n\n apiKey: \n\n5\n\n label: \"API Key\" \n\n6\n\n placeholder: \"apiKey\" \n\n7\n\n name: \"News Agent\" \n\n8\n\n description: \"Expert in searching and providing news about any topic\" \n\n9\n\n instructions: \n\n10\n\n - \"You are an expert in searching and providing updated news about any topic\" \n\n11\n\n - \"When the user asks about a topic, you should search and present the most relevant news\" \n\n12\n\n - \"Always be helpful and provide brief context about the news found\" \n\n13\n\n - \"If you can't find news about the topic, suggest related topics\" \n\n14\n\n - \"Always use english to answer the user and be polite\" \n\n15\n\n guardrails: \n\n16\n\n - \"Maintain a professional and impartial tone when presenting news\" \n\n17\n\n - \"Don't make assumptions or speculations about the news\" \n\n18\n\n - \"Avoid sharing sensationalist or unverified news\" \n\n19\n\n tools: \n\n20\n\n - get_news: \n\n21\n\n name: \"Get News\" \n\n22\n\n source: \n\n23\n\n path: \"tools/get_news\" \n\n24\n\n entrypoint: \"main.GetNews\" \n\n25\n\n path_test: \"test_definition.yaml\" \n\n26\n\n description: \"Function to get the latest news from NewsAPI\" \n\n27\n\n parameters: \n\n28\n\n - topic: \n\n29\n\n description: \"Topic to search for news\" \n\n30\n\n type: \"string\" \n\n31\n\n required: true \n\n32\n\n contact_field: true \n\n`\n\n### Tool Implementation\n\nCreate a file `tools/get_news/main.py`:\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\nfrom datetime import datetime \n\n6\n\n \n7\n\n \n8\n\nclass GetNews(Tool): \n\n9\n\n def execute(self, context: Context) -> TextResponse: \n\n10\n\n apiKey = context.credentials.get(\"apiKey\") \n\n11\n\n \n12\n\n topic = context.parameters.get(\"topic\", \"\") \n\n13\n\n news_response = self.get_news_by_topic(topic=topic, apiKey=apiKey) \n\n14\n\n \n15\n\n # Format the response \n\n16\n\n articles = news_response.get(\"articles\", []) \n\n17\n\n if not articles: \n\n18\n\n return TextResponse(data=\"Sorry, I couldn't find any news on this topic.\") \n\n19\n\n \n20\n\n response_data = { \n\n21\n\n \"status\": news_response.get(\"status\"), \n\n22\n\n \"totalResults\": len(articles[:10]), \n\n23\n\n \"articles\": [] \n\n24\n\n } \n\n25\n\n \n26\n\n # Get only the first 10 articles \n\n27\n\n for article in articles[:10]: \n\n28\n\n article_data = { \n\n29\n\n \"source\": article.get(\"source\", {}), \n\n30\n\n \"author\": article.get(\"author\"), \n\n31\n\n \"title\": article.get(\"title\"), \n\n32\n\n \"description\": article.get(\"description\"), \n\n33\n\n \"url\": article.get(\"url\"), \n\n34\n\n \"urlToImage\": article.get(\"urlToImage\"), \n\n35\n\n \"publishedAt\": article.get(\"publishedAt\"), \n\n36\n\n \"content\": article.get(\"content\") \n\n37\n\n } \n\n38\n\n response_data[\"articles\"].append(article_data) \n\n39\n\n \n40\n\n return TextResponse(data=response_data) \n\n41\n\n \n42\n\n def get_news_by_topic(self, topic, apiKey): \n\n43\n\n url = f\"https://newsapi.org/v2/everything\" \n\n44\n\n params = { \n\n45\n\n \"q\": topic, \n\n46\n\n \"sortBy\": \"popularity\", \n\n47\n\n \"apiKey\": apiKey, \n\n48\n\n \"language\": \"en\" \n\n49\n\n } \n\n50\n\n response = requests.get(url, params=params) \n\n51\n\n return response.json() \n\n`\n\nCreate a file `tools/get_news/requirements.txt`:\n\n`1\n\nrequests==2.32.3 \n\n`\n\nCreate a file `tools/get_news/test_definition.yaml`:\n\n`1\n\ntests: \n\n2\n\n test_1: \n\n3\n\n credentials: \n\n4\n\n apiKey: \"your_api_key_here\" \n\n5\n\n parameters: \n\n6\n\n topic: \"technology\" \n\n`\n\n### Getting Credentials\n\nFor this agent to work properly, you'll need to get an API key from News API:\n\n1. Visit the [News API](https://read.calvincode.net/reader?url=https://newsapi.org/) website\n2. Register for a free account\n3. Copy your API key from your account\n4. When deploying the agent, you'll need to provide this key as a credential\n\n### Testing the Tool Locally\n\nBefore deploying your agent, you can test the tool locally using the `weni run` command. This allows you to verify that your tool works correctly and debug any issues.\n\nSince this tool requires credentials, create a `.env` file in the tool folder with your API key (e.g., `tools/get_news/.env`):\n\n`1\n\napiKey=your_actual_news_api_key_here \n\n`\n\nTo test the News Agent tool:\n\n`1\n\nweni run agent_definition.yaml news_agent get_news \n\n`\n\nThis command will execute the tests defined in the `test_definition.yaml` file and show you the output. The CLI will automatically pick up the credentials from the tool folder `.env` file and make them available to your tool during execution.\n\nIf you need more detailed logs for debugging, you can add the `-v` flag:\n\n`1\n\nweni run agent_definition.yaml news_agent get_news -v \n\n`\n\nThe verbose output will show you more details about the execution process, helping you identify and fix any issues with your tool.\n\n### Deployment Steps\n\n1. Deploy the agent:\n\n`1\n\n weni project push agent_definition.yaml \n\n`\n\n### Testing\n\nAfter deployment, you can test the agent:\n\n1. Open your project in the Weni by VTEX platform\n2. Find the News Agent in your agents list\n3. Provide the News API key in the credential settings\n4. Start a conversation\n5. Send a topic to search for news (e.g., \"technology\", \"sports\", \"business\")\n\nThe agent will respond with the most relevant news about the requested topic, including title, description, source, author, publication date, and links to the full article.\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/working-with-weni-by-vtex-agents.md)\n\n[Understanding the core concepts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents//docs/guides/weni-by-vtex-understanding-the-core-concepts)[Fetching and filtering logsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents//docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\n\nON THIS PAGE\n\n[Agent Definition File](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-definition-file)\n\n[Key Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23key-components)[Tool Source Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-source-configuration)\n\n[Creating Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23creating-tools)\n\n[Tool Implementation Structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-implementation-structure)\n\n[Deploying Agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deploying-agents)\n\n[Push Command](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23push-command)[Deployment Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deployment-best-practices)\n\n[Advanced Topics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23advanced-topics)\n\n[Parameter Types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23parameter-types)[Response Formats](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23response-formats)[Error Handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23error-handling)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23troubleshooting)\n\n[Common Issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23common-issues)[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23best-practices)\n\n[Agent Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-examples)\n\n[Book Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23book-agent)\n\n[Agent Definition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-definition)[Tool Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-implementation)[Testing the Tool Locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing-the-tool-locally)[Deployment Steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deployment-steps)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing)\n\n[CEP Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23cep-agent)\n\n[Agent Definition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-definition)[Tool Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-implementation)[Testing the Tool Locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing-the-tool-locally)[Deployment Steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deployment-steps)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing)\n\n[Movie Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23movie-agent)\n\n[Agent Definition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-definition)[Tool Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-implementation)[Getting Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23getting-credentials)[Testing the Tool Locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing-the-tool-locally)[Deployment Steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deployment-steps)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing)\n\n[News Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23news-agent)\n\n[Agent Definition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-definition)[Tool Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-implementation)[Getting Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23getting-credentials)[Testing the Tool Locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing-the-tool-locally)[Deployment Steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deployment-steps)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing)\n\nWas this helpful?\n\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/working-with-weni-by-vtex-agents.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Agent Definition File](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-definition-file)\n\n[Key Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23key-components)[Tool Source Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-source-configuration)\n\n[Creating Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23creating-tools)\n\n[Tool Implementation Structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-implementation-structure)\n\n[Deploying Agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deploying-agents)\n\n[Push Command](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23push-command)[Deployment Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deployment-best-practices)\n\n[Advanced Topics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23advanced-topics)\n\n[Parameter Types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23parameter-types)[Response Formats](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23response-formats)[Error Handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23error-handling)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23troubleshooting)\n\n[Common Issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23common-issues)[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23best-practices)\n\n[Agent Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-examples)\n\n[Book Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23book-agent)\n\n[Agent Definition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-definition)[Tool Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-implementation)[Testing the Tool Locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing-the-tool-locally)[Deployment Steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deployment-steps)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing)\n\n[CEP Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23cep-agent)\n\n[Agent Definition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-definition)[Tool Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-implementation)[Testing the Tool Locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing-the-tool-locally)[Deployment Steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deployment-steps)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing)\n\n[Movie Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23movie-agent)\n\n[Agent Definition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-definition)[Tool Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-implementation)[Getting Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23getting-credentials)[Testing the Tool Locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing-the-tool-locally)[Deployment Steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deployment-steps)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing)\n\n[News Agent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23news-agent)\n\n[Agent Definition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23agent-definition)[Tool Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23tool-implementation)[Getting Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23getting-credentials)[Testing the Tool Locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing-the-tool-locally)[Deployment Steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23deployment-steps)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-weni-by-vtex-agents/docs/guides/working-with-weni-by-vtex-agents%23testing)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_1eae05e0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX search 1.0.8 Banner app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/vtex-io-apps)\n\nBanner\n\n[vtex.search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search)\n\nVersion: 1.0.8\n\nLatest version: 2.18.8\n\n> This page is about version **1.0.8** of the app, which is not the most recent version. The latest stable version is **2.18.8**.\n\nA simple banner with that can configured to appear depending on the context of the search.\n\n## Configuration\n\nThe banner entity is composed by the following fields:\n\n| Field | Description |\n| ---------------- | ---------------------------------------------------------------------------------------------------------------- |\n| Active | Indicates if banner is active or not. |\n| Banner name | Field used as an id. |\n| Type banner | Indicates the banner type. It can be HTML or IMAGE. |\n| HTML / Image URL | Html or image to be inserted. |\n| Area | Indicates which area the banner should appear. It is importante when there is multiple banners in the same page. |\n| Terms | List of terms for this banner. |\n| Period | The period that this banner will be active. |\n| Attributes | List of selected attributes for this banner. |\n\n## Usage\n\nAdd the `search-banner` block to the `search-result-layout.desktop` or `search-result-layout.mobile`. For example:\n\n`1\n\n\"search-result-layout.desktop\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#banner-one\", \n\n4\n\n ], \n\n5\n\n \"search-banner#one\": { \n\n6\n\n \"props\": { \n\n7\n\n \"area\": \"one\", \n\n8\n\n \"blockClass\": \"myBanner\", \n\n9\n\n \"horizontalAlignment\": \"center\" \n\n10\n\n } \n\n11\n\n }, \n\n12\n\n \"flex-layout.row#banner-one\": { \n\n13\n\n \"children\": [\"search-banner#one\"] \n\n14\n\n }, \n\n15\n\n} \n\n`\n\n## Props\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ------ | ----------------------------------------------------------------------- | ------------- |\n| area | String | Idicates the area. It needs to match the area configured in the banner. | \\- |\n| blockClass | String | Defines a custom class for the banner div. | \\- |\n| horizontalAlignment | String | Defines the horizontal alignment for the banner. | \"center\" |\n\nThe possible values for `horizontalAlignment` are:\n\n| Values |\n| -------- |\n| \"left\" |\n| \"right\" |\n| \"center\" |\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ------------ |\n| searchBanner |\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/apps/vtex.search)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/apps/vtex.search@1.0.8/Banner%23configuration)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/apps/vtex.search@1.0.8/Banner%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/apps/vtex.search@1.0.8/Banner%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Banner/docs/apps/vtex.search@1.0.8/Banner%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_701b5f90
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides delivery promise for headless stores in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/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/delivery-promise-for-headless-stores/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/consult-store-search-terms-information)\n\n[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/consult-product-search-information)\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/get-banner-list-for-a-specific-search)\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/access-control-list)\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores)\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/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/delivery-promise-for-headless-stores/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/delivery-promise-for-headless-stores/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/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/delivery-promise-for-headless-stores/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/consult-store-search-terms-information)\n\n[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/consult-product-search-information)\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/get-banner-list-for-a-specific-search)\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/access-control-list)\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores)\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/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/delivery-promise-for-headless-stores/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/delivery-promise-for-headless-stores/docs/guides)\n\nSearch\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores)\n\nDelivery promise for headless stores (Beta)\n\nLearn how to implement the delivery promise feature in headless stores.\n\n> This feature is in closed beta, which means that only selected customers can access it for now. If you are interested in implementing it in the future, please contact our [Support](https://read.calvincode.net/reader?url=https://support.vtex.com/hc/en-us) team.\n\nThis guide details how to use the [Delivery Promise](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/delivery-promise-beta--p9EJH9GgxL0JceA6dBswd) feature on headless stores, using [Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api) with additional facets for this purpose.\n\nOnly products that can be delivered to the provided address or picked up at pickup points are displayed, following these rules:\n\n* The system displays all available pickup points within the 50 km radius configured in Checkout. This applies when the customer selects pickup in the header or a specific pickup point. There’s no limit to the number of pickup points displayed. To enable this functionality, you must fetch the complete list of pickup points using the [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/pickup-points). Retrieving this list is a mandatory dependency for the Delivery Promise feature in headless stores.\n* For the nearby pickup filter, pickup points within a 10 km radius of the buyer's location are shown, with a maximum of 40 pickup points.\n\n## Before you begin\n\n* Make sure you have Intelligent Search installed, namely admin-search and search-resolver. Learn more at [Installing Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4mwZGH252R3CCPRim8v0F3).\n* Complete Catalog integration with Intelligent Search. Learn more at [Starting the integration with Catalog](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/2wBsO1AKTQZ04idbTKszI4).\n\n## Using Delivery Promise parameters\n\nThe `GET` [Get list of products for a query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/product%5Fsearch/-facets-) endpoint from Intelligent Search API accepts path parameters referred to as facets:\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/io/_v/api/intelligent-search/product_search/{facets} \n\n`\n\nTo enable the Delivery Promise functionality, you should use the following additional query strings and facets on this request. When possible, using query strings is recommended for better performance.\n\n| Query string / Facet | Description | Example |\n| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |\n| zip-code **\\[required\\]** (query string) | Postal code. | **?zip-code=22250040** |\n| shipping (facet) | Shipping method. It must always be combined with zip-code. Possible values: pickup-in-point, delivery, pickup-all, pickup-nearby | /shipping/pickup-in-point/?zip-code=22250040 |\n| pickupPoint (query string) | Pickup point ID to filter by a specific pickup point. This is used only with the shipping/pickup-in-point facet, besides the required parameters. | /shipping/pickup-in-point?zip-code=22250040&pickupPoint=vtex-botafogo |\n| delivery-options (facet) | [Delivery Option](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/delivery-options-beta--1fRDJFcHCtpTnk7GNyaRDY) ID or IDs to be filtered. The ID can be obtained in the VTEX Admin, at **Shipping > Delivery Options**. It must always be combined with zip-code. Multiple entries of this filter can be used in the request to search for multiple Delivery Options. | **/delivery-options/express-option-id**?zip-code=22250040 |\n| dynamic-estimate (facet) | The Dynamic Estimate filter selects Delivery Options that can meet the requested delivery or pickup timeframe. It must always be used together with zip-code and shipping. Possible values: same-day, next-day. It dynamically identifies which Delivery Options for the given zip-code and shipping facet can meet the requested timeframe, and then filters the search as if those Delivery Options had been manually passed as filters. | /shipping/delivery/dynamic-estimate/same-day?zip-code=22250040 |\n| hideUnavailableItems (query string) | Controls whether the search returns only available products or both available and unavailable ones. When set to true, only products with stock are returned; when set to false, the API includes unavailable products as well. A product is considered unavailable when availableQuantity = 0, while availableQuantity = 10000 indicates that the product is available. Retailers may choose to show unavailable items for commercial reasons (for example, to signal that they carry those products even if temporarily out of stock), while the recommended default is true. This facet also allows merchants to expose a shopper-facing filter such as \"show only in-stock products.\" If hideUnavailableItems is omitted, products with the ShowIfNotAvailable property set to true in the Catalog may appear even if unavailable. Learn more about the ShowIfNotAvailable property in the [Catalog API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api?endpoint=get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitbyid/-skuId-). | ?hideUnavailableItems=true |\n\n> `zip-code` is **required** to filter product availability according to the shopper’s location and is integral to any request using Delivery Promise functionality. This means you must use it when filtering by shipping method and pickup point.\n\n> To ensure only products that are available for delivery or pickup are returned, you must include the `hideUnavailableItems=true` query parameter in your requests. If this parameter is omitted, the search engine will include products with the `ShowIfNotAvailable` property set to `true` in the Catalog module even if they are not available for delivery or pickup. For example, product `649553` may appear in results if it has `ShowIfNotAvailable` enabled, unless you explicitly set `hideUnavailableItems=true`. Learn more about the `ShowIfNotAvailable` property in the [Catalog API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api?endpoint=get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitbyid/-skuId-).\n\nFor more information on facet options apart from the ones directly related to Delivery Promise, go to `GET` [Get list of products for a query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/product%5Fsearch/-facets-).\n\n### Filter combinations\n\nWhen shoppers apply filters, the API combines them according to the following rules:\n\n* **Facets of the same type → OR (union):** when multiple values of the same facet are applied, the API returns the union of all products matching any of those values.\n* **Facets of different types → AND (intersection):** when different facet types are combined, the API returns only the products that satisfy all selected facet conditions simultaneously.\n\nThis results in the following behavior when using Delivery Options and Dynamic Estimates:\n\n* **Multiple Delivery Options → OR (union):** the API returns all products that match any of the delivery options selected by the shopper.\n* **Dynamic Estimate + Delivery Option → AND (intersection):** the API returns only the products that satisfy both the selected dynamic estimate and the chosen delivery option.\n\n### Filtering by location\n\nHere is an example of a basic Delivery Promise search using only postal code:\n\n`1\n\nhttps://{{accountName}}.myvtex.com/api/io/_v/api/intelligent-search/product_search?zip-code=22250040 \n\n`\n\n### Filtering by shipping method\n\nTo filter the search by a shipping method, you must use the `shipping` parameter and some additional optional parameters, depending on the type of filter you want to implement.\n\nThe possible filters are:\n\n* [Delivery to the shopper’s ZIP code](#delivery-to-the-shopper's-zip-code)\n* [Pickup at a specific location](#pickup-at-a-specific-location)\n* [Pickup at a nearby location](#pickup-at-a-nearby-location)\n\nLearn more about each of them in the following sections.\n\n#### Delivery to the shopper’s ZIP code\n\nFilters the search for products that can be delivered to the zip code entered by the buyer.\n\nParameters: `/shipping/delivery`\n\nExample:\n\n`1\n\nhttps://{{accountName}}.myvtex.com.br/api/io/_v/api/intelligent-search/product_search/shipping/delivery?zip-code=22250040 \n\n`\n\n#### Pickup at a specific location\n\nFilters the search for products that can be picked up at a specific pickup point selected by the buyer.\n\nParameters: `/shipping/pickup-in-point/pickupPoint/{pickupPointId}`\n\n> We are working on an endpoint that will simplify retrieving pickup points directly. For now, to fetch the list of pickup points for the store and their IDs, follow the [List pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location) guide and [API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/pickup-points).\n\nExample:\n\n`1\n\nhttps://{{accountName}}.myvtex.com/api/io/_v/api/intelligent-search/product_search/shipping/pickup-in-point/pickupPoint/vtex-botafogo?zip-code=22250040 \n\n`\n\n#### Pickup at a nearby location\n\nFilters the search for products that can be picked up at pickup points located within a radius of up to 50 km from the shopper, within the same pickup radius limit as the Checkout.\n\nParameters: `/shipping/pickup-in-point/pickup-nearby`\n\nExample:\n\n`1\n\nhttps://{{accountName}}.myvtex.com/api/io/_v/api/intelligent-search/product_search/shipping/pickup-in-point/pickup-nearby?zip-code=22250040 \n\n`\n\n### Filtering by Delivery Options\n\nDelivery Options are the set of choices a merchant provides to shoppers, describing how and when an order can be delivered, along with relevant metadata such as estimated delivery time.\n\nBefore you can display Delivery Option filters, it is necessary to:\n\n* Enable the Delivery Options feature by contacting [our Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n* Create the Delivery Options for your store in the VTEX Admin following the instructions in the [Delivery Options](https://read.calvincode.net/reader?url=https://help.vtex.com/docs/tutorials/delivery-options-beta) guide.\n\nTo filter by a Delivery Option, use the `delivery-options` parameter. Its value must be the ID for one of the Delivery Options configured on your store.\n\nExample:\n\n`1\n\nhttps://{{accountName}}.myvtex.com/api/io/_v/api/intelligent-search/product_search/delivery-options/express-option-id?zip-code=22250040 \n\n`\n\nYou can also filter for multiple Delivery Options by including multiple entries for the `delivery-options` parameter on the request.\n\nExample:\n\n`1\n\nhttps://{{accountName}}.myvtex.com/api/io/_v/api/intelligent-search/product_search/delivery-options/one-week-option-id/delivery-options/one-day-option-id?zip-code=22250040 \n\n`\n\n### Filtering by Dynamic Estimates\n\nDynamic Estimates for the delivery or pickup of a product are computed in real-time when searching. They are based on the store’s logistics operations, time of day and any product properties that might affect them. The possible values are _Same-day Delivery_ and _Next-day Delivery_.\n\nTo filter by a Dynamic Estimate, you must use the `dynamic-estimate` parameter.\n\n#### Same-day Delivery\n\nFilters the search for products that can be delivered or picked up at the provided `zip-code` on the **same day**.\n\nExample:\n\n`1\n\nhttps://{{accountName}}.myvtex.com/api/io/_v/api/intelligent-search/product_search/dynamic-estimate/same-day?zip-code=22250040 \n\n`\n\n#### Next-day Delivery\n\nFilters the search for products that can be delivered or picked up at the provided `zip-code` on the **next day**.\n\nExample:\n\n`1\n\nhttps://{{accountName}}.myvtex.com/api/io/_v/api/intelligent-search/product_search/dynamic-estimate/next-day?zip-code=22250040 \n\n`\n\n## Implementing sidebar filters\n\n> The delivery promise filters are part of a beta feature and may be subject to breaking changes. If you choose to customize this functionality, ensure your implementation can adapt to updates.\n\nIn headless implementations, you must manually retrieve and render filters using VTEX Intelligent Search APIs. For example, inside a filter sidebar, where you want users to refine results based on shipping method or pickup location.\n\nYou can retrieve available filters using the `GET` [Get facets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/facets/-facets-) endpoint and use the response to build a custom filter UI in your headless storefront. For example, mapping `name: \"pickup-in-point\"` to a checkbox labeled **Pickup in store**.\n\n> Delivery-related filters (e.g. delivery, pickup-in-point) are included in the `facets` response. These are tied to the user's session and shipping context ([segment token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/session-manager-api%23post-/api/sessions)). Make sure the segment and shipping data are initialized correctly for this to work.\n\n**Example request:**\n\n`1\n\nGET https://{{accountName}}.myvtex.com/_v/api/intelligent-search/facets/?query=moisturizer \n\n`\n\n**Example response:**\n\n`1\n\n{ \n\n2\n\n \"facets\": [ \n\n3\n\n { \n\n4\n\n \"name\": \"Shipping Method\", \n\n5\n\n \"values\": [ \n\n6\n\n { \"id\": \"delivery\", \"name\": \"Delivery\", \"quantity\": 142 }, \n\n7\n\n { \"id\": \"pickup-in-point\", \"name\": \"Pickup in Store\", \"quantity\": 37 } \n\n8\n\n ] \n\n9\n\n }, \n\n10\n\n { \n\n11\n\n \"name\": \"Pickup Location\", \n\n12\n\n \"values\": [ \n\n13\n\n { \"id\": \"vtex-botafogo\", \"name\": \"VTEX Botafogo\", \"quantity\": 12 }, \n\n14\n\n { \"id\": \"vtex-sp\", \"name\": \"VTEX Sao Paulo\", \"quantity\": 8 } \n\n15\n\n ] \n\n16\n\n } \n\n17\n\n ] \n\n18\n\n} \n\n`\n\nContributors\n\n3\n\n[](https://github.com/barbara-celi)\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/Search/delivery-promise-for-headless-stores.md)\n\n[Access Control List« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores//docs/guides/access-control-list)[Storefront Permissions OverviewNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores//docs/guides/storefront-permissions)\n\nContributors\n\n3\n\n[](https://github.com/barbara-celi)\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/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23before-you-begin)\n\n[Using Delivery Promise parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23using-delivery-promise-parameters)\n\n[Filter combinations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23filter-combinations)[Filtering by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23filtering-by-location)[Filtering by shipping method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23filtering-by-shipping-method)[Filtering by Delivery Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23filtering-by-delivery-options)[Filtering by Dynamic Estimates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23filtering-by-dynamic-estimates)\n\n[Implementing sidebar filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23implementing-sidebar-filters)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Search/delivery-promise-for-headless-stores.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23before-you-begin)\n\n[Using Delivery Promise parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23using-delivery-promise-parameters)\n\n[Filter combinations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23filter-combinations)[Filtering by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23filtering-by-location)[Filtering by shipping method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23filtering-by-shipping-method)[Filtering by Delivery Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23filtering-by-delivery-options)[Filtering by Dynamic Estimates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23filtering-by-dynamic-estimates)\n\n[Implementing sidebar filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores/docs/guides/delivery-promise-for-headless-stores%23implementing-sidebar-filters)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_ecb7cf92
|
[
{
"role": "system",
"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 policies system 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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-api/docs/api-reference/policies-system-api/)\n\nPolicy\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-api/docs/api-reference/policies-system-api/)\n\nPolicy\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-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/policies-system-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[DeDelete BIN location« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api/docs/api-reference/pick-and-pack-order-changes-api%23delete-/-skuId-/warehouses/-warehouseId-)[GeGet Policy ListNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api/docs/api-reference/policies-system-api%23get-/api/policy-engine/policies)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0d07dc78
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore analytics send analytics event in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-overview)\n\n[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event)\n\n[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-use-analytics-event)\n\n[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-sending-custom-events)\n\n[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-extending-and-customizing-native-types)\n\n[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-overview)\n\n[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event)\n\n[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-use-analytics-event)\n\n[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-sending-custom-events)\n\n[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-extending-and-customizing-native-types)\n\n[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-overview)\n\nsendAnalyticsEvent\n\nThe `sendAnalyticsEvent` function triggers events in the browser, following the [Google Analytics 4 (GA4) data model](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events). This function is primarily used for ecommerce tracking but also supports custom events, serving as a centralized point for managing events.\n\n> `sendAnalyticsEvent` doesn't send events to any analytics provider. To intercept events triggered by this function, use the [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event) hook.\n\n## Import\n\n`1\n\nimport { sendAnalyticsEvent } from '@faststore/sdk' \n\n`\n\n## Usage\n\nIn the event-related component, define a callback function that creates an event object with the desired type (for example, `add_to_cart`) and calls `sendAnalyticsEvent`, passing the event as an argument. Then, trigger the callback function in the corresponding event handler (such as `onClick`).\n\nThe example below shows an `add_to_cart` event triggered by the `button` component:\n\n`1\n\nimport { useCallback } from 'react' \n\n2\n\nimport { sendAnalyticsEvent } from '@faststore/sdk' \n\n3\n\n \n4\n\nconst MyComponent = () => { \n\n5\n\n const addToCartCallback = useCallback(() => { \n\n6\n\n import('@faststore/sdk').then(({ sendAnalyticsEvent }) => { \n\n7\n\n /* ... */ \n\n8\n\n \n9\n\n const addToCartEvent = { \n\n10\n\n name: 'add_to_cart', \n\n11\n\n params: { \n\n12\n\n items: [ \n\n13\n\n /* ... */ \n\n14\n\n ], \n\n15\n\n }, \n\n16\n\n } \n\n17\n\n \n18\n\n sendAnalyticsEvent(addToCartEvent) \n\n19\n\n }) \n\n20\n\n }, []) \n\n21\n\n \n22\n\n return <button onClick={addToCartCallback}>Add to cart</button> \n\n23\n\n} \n\n`\n\nCheck the list of [available types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview%23list-of-native-event-types).\n\n## Parameters\n\nThe `sendAnalyticsEvent` function accepts an event object with the following properties:\n\n| Property | Type | Description | Default |\n| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |\n| name | string | The name of the event in Analytics reports. | Required |\n| params | object | Event-specific parameters and data. | Required |\n| isEcommerceEvent | boolean | Determines event structure. When true, wraps params in an ecommerce object following the GA4 ecommerce data model. When false, sends params at the top level for custom non-ecommerce events. | true |\n\n### `isEcommerceEvent`\n\nBy default, `sendAnalyticsEvent` wraps event parameters in an `ecommerce` object to follow the [Google Analytics 4 ecommerce events](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/14434488?hl=en) structure. However, for custom events that don't represent ecommerce actions, you should set `isEcommerceEvent: false` to send parameters at the top level, following the [GA4 custom events format](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/14240153?hl=en).\n\n#### Custom events without GA4 `ecommerce` (`isEcommerceEvent: false`)\n\n`1\n\nimport { sendAnalyticsEvent } from '@faststore/sdk' \n\n2\n\n \n3\n\nsendAnalyticsEvent({ \n\n4\n\n name: 'newsletter_signup', \n\n5\n\n isEcommerceEvent: false, \n\n6\n\n params: { \n\n7\n\n method: 'footer_form', \n\n8\n\n user_type: 'new_visitor', \n\n9\n\n email_preference: 'weekly' \n\n10\n\n } \n\n11\n\n}) \n\n`\n\nThis sends the event as:\n\n`1\n\n{ \n\n2\n\n \"event\": \"newsletter_signup\", \n\n3\n\n \"method\": \"footer_form\", \n\n4\n\n \"user_type\": \"new_visitor\", \n\n5\n\n \"email_preference\": \"weekly\" \n\n6\n\n} \n\n`\n\n#### GA4 ecommerce event (`isEcommerceEvent: true`)\n\nUse `isEcommerceEvent: true` (default) to format the event according to the GA4 ecommerce data model, wrapping all parameters inside the ecommerce object. See the following example:\n\n`1\n\nimport { sendAnalyticsEvent } from '@faststore/sdk' \n\n2\n\n \n3\n\nsendAnalyticsEvent({ \n\n4\n\n name: 'add_to_cart', \n\n5\n\n params: { \n\n6\n\n currency: 'USD', \n\n7\n\n value: 29.99, \n\n8\n\n items: [{ item_id: '12345', item_name: 'Product Name' }] \n\n9\n\n } \n\n10\n\n}) \n\n`\n\nThis sends the event as:\n\n`1\n\n{ \n\n2\n\n \"event\": \"add_to_cart\", \n\n3\n\n \"ecommerce\": { \n\n4\n\n \"currency\": \"USD\", \n\n5\n\n \"value\": 29.99, \n\n6\n\n \"items\": [{ \"item_id\": \"12345\", \"item_name\": \"Product Name\" }] \n\n7\n\n } \n\n8\n\n} \n\n`\n\n## Typed custom events\n\nThe `sendAnalyticsEvent` function supports generics, enabling you to extend default types or modify existing ones. This approach provides type checking and code suggestions for your custom event properties.\n\nThis typing is independent of how the event is packaged by `isEcommerceEvent`. You can use generics for both GA4 ecommerce events and non-ecommerce custom events.\n\nConsider the following example of providing a custom type reference for `sendAnalyticsEvent`:\n\n`` 1\n\nimport { sendAnalyticsEvent } from '@faststore/sdk' \n\n2\n\n \n3\n\ninterface CustomEvent { \n\n4\n\n name: 'custom_event' \n\n5\n\n params: { \n\n6\n\n customProperty?: string \n\n7\n\n } \n\n8\n\n} \n\n9\n\n \n10\n\n/** \n\n11\n\n * By passing `CustomEvent` as a generic type to `sendAnalyticsEvent`, you will receive code suggestions for all properties of this type, including nested properties within `params`. \n\n12\n\n */ \n\n13\n\nsendAnalyticsEvent<CustomEvent>(/* ... */) \n\n ``\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/analytics/send-analytics-event.mdx)\n\n[Analytics« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-overview)[useAnalyticsEventNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-use-analytics-event)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event%23usage)\n\n[Parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event%23parameters)\n\n[isEcommerceEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event%23isecommerceevent)\n\n[Typed custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event%23typed-custom-events)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/analytics/send-analytics-event.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event%23usage)\n\n[Parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event%23parameters)\n\n[isEcommerceEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event%23isecommerceevent)\n\n[Typed custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event/docs/guides/faststore/analytics-send-analytics-event%23typed-custom-events)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d6c55a2c
|
[
{
"role": "system",
"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 reviews and ratings 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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-api/docs/api-reference/reviews-and-ratings-api/)\n\nRating\n\nReview\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-api/docs/api-reference/reviews-and-ratings-api/)\n\nRating\n\nReview\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-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/reviews-and-ratings-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeFinish punchout login flow (headless)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-api/docs/api-reference/punchout-api%23get-/api/authenticator/punchout/finish)[GeGet product ratingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-api/docs/api-reference/reviews-and-ratings-api%23get-/reviews-and-ratings/api/rating/-productId-)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_90121c49
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides update an account orderform configuration in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/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/update-an-account-orderform-configuration/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/configuration-section-api-quick-start-guides)\n\n[Getting an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/get-an-account-orderform-configuration)\n\n[Updating an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration)\n\n[Get and update the seller exchange window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/get-and-update-the-seller-exchange-window)\n\n[Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/clear-orderform-message-field-from-cart)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/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/update-an-account-orderform-configuration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/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/update-an-account-orderform-configuration/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/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/update-an-account-orderform-configuration/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/configuration-section-api-quick-start-guides)\n\n[Getting an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/get-an-account-orderform-configuration)\n\n[Updating an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration)\n\n[Get and update the seller exchange window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/get-and-update-the-seller-exchange-window)\n\n[Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/clear-orderform-message-field-from-cart)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/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/update-an-account-orderform-configuration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/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/update-an-account-orderform-configuration/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/checkout-api-overview)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/configuration-section-api-quick-start-guides)\n\n[Updating an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration)\n\nUpdate an account's orderForm configuration\n\nThe orderForm is the main object processed by VTEX checkout, and one of the most important data structures in the architecture of every VTEX store. It stores a lot of contextual information about the order which is important to the processing of the order: order items, client's personal data, delivery address, freight information, etc.\n\nThis guide will describe how to update settings applied currently to every orderForm in a specific account.\n\n> Always retrieve the current orderForm configuration before performing an update to ensure that you are modifying only the properties you want. Otherwise, old values can be overwritten. To get the current orderForm configuration for a specific account, check the [Get orderForm configuration developer's guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm).\n\n## Updating an account's orderForm configuration\n\nTo update an account orderForm configuration, you need to use the [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updateorderformconfiguration) endpoint. In this request, you must send the `accountname` through the URL address, as shown by the example below:\n\n`https://{accountName}.{environment.com.br}/api/checkout/pvt/configuration/orderForm`\n\nAdditionally, you can submit the following information to modify your account's orderForm configuration:\n\n* `paymentConfiguration`: payment configuration information. \n * `requiresAuthenticationForPreAuthorizedPaymentOption`: determines whether pre-authorized payments require authentication. This field is mandatory and must be sent in all requests. \n * `allowInstallmentsMerge`: when in a multi-seller purchase scenario, it allows a flexible installment option that considers maximum installments for each seller, according to their respective configuration options. \n * `paymentSystemToCheckFirstInstallment`: option to apply a first installment discount to a particular payment system.\n* `taxConfiguration`: external tax service configuration information. \n * `url`: endpoint URL. \n * `authorizationHeader`: authorization header. \n * `appId`: custom data ID sent to the tax system.\n* `minimumQuantityAccumulatedForItems`: minimum SKU quantity by cart. This field is mandatory and must be sent in all requests.\n* `decimalDigitsPrecision`: number of price digits.\n* `minimumValueAccumulated`: minimum cart value.\n* `apps`: apps configuration information. \n * `fields`: app fields information. \n * `id`: app ID. \n * `major`: app major version.\n* `allowMultipleDeliveries`: allows the selection of items from several delivery channels in the same purchase.\n* `allowManualPrice`: allows the editing of SKU prices directly in the cart.\n* `savePersonalDataAsOptIn`: allows users to select whether they want the store to keep their personal and payment data saved.\n* `maxNumberOfWhiteLabelSellers`: allows the input of a limit of white label sellers involved on the cart.\n* `maskFirstPurchaseData`: allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client doesn't want to share its data.\n* `recaptchaValidation`: configures reCAPTCHA validation status for the account.\n* `requiresLoginToPlaceOrder`: indicates whether authentication is required for completing purchases.\n* `minimumPurchaseDowntimeSeconds`: minimum interval (in seconds) between successive purchases.\n* `cartAgeToUseNewCardSeconds`: minimum cart existence period (in seconds) before allowing the use of a new credit card.\n\nSee a request body example below:\n\n`1\n\n{ \n\n2\n\n \"paymentConfiguration\": { \n\n3\n\n \"requiresAuthenticationForPreAuthorizedPaymentOption\": true \n\n4\n\n }, \n\n5\n\n \"recaptchaValidation\": \"vtexCriteria\", \n\n6\n\n \"minimumValueAccumulated\": 5, \n\n7\n\n \"maxNumberOfWhiteLabelSellers\": 2, \n\n8\n\n \"maskFirstPurchaseData\": false, \n\n9\n\n \"decimalDigitsPrecision\": 2, \n\n10\n\n \"minimumQuantityAccumulatedForItems\": 8, \n\n11\n\n \"requiresLoginToPlaceOrder\": true, \n\n12\n\n \"minimumPurchaseDowntimeSeconds\": 90, \n\n13\n\n \"cartAgeToUseNewCardSeconds\": 30, \n\n14\n\n \"apps\": [ \n\n15\n\n { \n\n16\n\n \"fields\": [ \n\n17\n\n \"gender\", \n\n18\n\n \"age\" \n\n19\n\n ], \n\n20\n\n \"id\": \"profile\", \n\n21\n\n \"major\": 1 \n\n22\n\n }, \n\n23\n\n { \n\n24\n\n \"fields\": [ \n\n25\n\n \"address\" \n\n26\n\n ], \n\n27\n\n \"id\": \"address\", \n\n28\n\n \"major\": 1 \n\n29\n\n } \n\n30\n\n ] \n\n31\n\n} \n\n`\n\nAfter sending the request, the endpoint will return `code 204 (No Content)` and an empty response body.\n\nTo confirm that the new orderForm settings have been applied to your account, access the [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorderformconfiguration) endpoint again.\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 401 - Unauthorized\n\n* **Message error example (code ORD062)**: `\"Unauthorized\"`. The credentials (API key and API token) used in this request are incorrect or not authorized to access this type of information.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD062\", \n\n5\n\n \"message\": \"Unauthorized\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"8ec4b686-435f-42ab-8cfd-89306f888c3c\" \n\n9\n\n} \n\n`\n\n### 404 - Not Found\n\n* **Message error example**: `\"The requested URL was not found on the server\"`: check that the URL data is correct.\n\n`1\n\n<body> \n\n2\n\n <h1>404 Not Found</h1> \n\n3\n\n <p>The requested URL was not found on this server.</p> \n\n4\n\n</body> \n\n`\n\nContributors\n\n4\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/geisecosta)\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/white-label-sellers-selection-algorithm/update-an-account-orderform-configuration.md)\n\n[Getting an account orderForm configuration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration//docs/guides/get-an-account-orderform-configuration)[Get and update the seller exchange windowNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration//docs/guides/get-and-update-the-seller-exchange-window)\n\nContributors\n\n4\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Updating an account's orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration%23updating-an-accounts-orderform-configuration)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration%23error-codes)\n\n[401 - Unauthorized](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration%23401-unauthorized)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration%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/white-label-sellers-selection-algorithm/update-an-account-orderform-configuration.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Updating an account's orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration%23updating-an-accounts-orderform-configuration)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration%23error-codes)\n\n[401 - Unauthorized](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration%23401-unauthorized)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration/docs/guides/update-an-account-orderform-configuration%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_67640d7c
|
[
{
"role": "system",
"content": "You are a VTEX 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 product name control works in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)\n\n[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/can-i-order-my-product-as-i-want)\n\n[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/list-of-controls-for-templates)\n\n[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/creating-gift-lists)\n\n[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/validating-a-layout-before-moving-it-to-production)\n\n[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/how-to-use-the-page-title-control)\n\n[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/how-product-name-control-works)\n\n[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/shelf-template-controls)\n\n[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/control-to-disable-the-canonical-tag)\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)\n\n[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/can-i-order-my-product-as-i-want)\n\n[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/list-of-controls-for-templates)\n\n[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/creating-gift-lists)\n\n[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/validating-a-layout-before-moving-it-to-production)\n\n[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/how-to-use-the-page-title-control)\n\n[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/how-product-name-control-works)\n\n[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/shelf-template-controls)\n\n[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/control-to-disable-the-canonical-tag)\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/storefront-development)\n\n(Legacy) CMS Portal\n\n[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works/docs/guides/how-product-name-control-works)\n\nHow product name control works\n\nThe `<vtex.cmc:productName/>` control renders the product name as registered in the catalog.\n\nTherefore, it works only on product pages.\n\nThe name rendered by this control is that of the **product**, not the SKU.\n\nThis is an example of the HTML code rendered by the Product Name control.\n\n`1\n\n<div class=\"fn productName Oculos-de-natacao-Speedo-Glypse \">Óculos de natação Speedo Glypse</div> \n\n2\n\n<input id=\"___rc-p-id\" type=\"hidden\" value=\"2\"> \n\n3\n\n<input id=\"___rc-p-dv-id\" type=\"hidden\" value=\"39,1\"> \n\n4\n\n<input id=\"___rc-p-sku-ids\" type=\"hidden\" value=\"2\"> \n\n5\n\n<input id=\"___rc-p-kit-ids\" type=\"hidden\" value=\"\"> \n\n`\n\nNotice that the product name appears inside a `<div>` tag, which receives the `productName` class.\n\nYou don't have to worry about the four `<input>` tags also rendered by the control. They have internal function to the platform.\n\nContributors\n\n1\n\n[](https://github.com/jumeyermattosarruda)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/legacy-cms/how-product-name-control-works.md)\n\n[How to use the page title control« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works//docs/guides/how-to-use-the-page-title-control)[Configure the price history controlNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-product-name-control-works//docs/guides/configure-the-price-history-control)\n\nContributors\n\n1\n\n[](https://github.com/jumeyermattosarruda)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/legacy-cms/how-product-name-control-works.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_568e59cd
|
[
{
"role": "system",
"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 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/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/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/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/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/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/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/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/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/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/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/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/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/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/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/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/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/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/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/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/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/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/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/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/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/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/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/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/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/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/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/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/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/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/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/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/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/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/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/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/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/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/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/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/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/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/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/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/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/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/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/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/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/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/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/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/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/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/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/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/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/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/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/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/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/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/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/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/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/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/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/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/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/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/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/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/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/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/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/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/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/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/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/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/docs/api-reference/orders-api-pii-version/)\n\n---\n\nAPI Reference\n\nUse our API reference documentation to build custom solutions that fit your business.\n\n\n\n[Antifraud Provider APIUse the Antifraud Provider Protocol to integrate your antifraud service API into the VTEX platform.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/antifraud-provider-protocol)[Legacy CMS Portal APIUpdate your websites’ internet communication protocolSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/legacy-cms-portal-api)[Catalog APIManipulate your store’s sales channels, categories, brands, products, SKUs and specifications.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/catalog-api)[Catalog API - Seller PortalCreate, edit and consult products and their variations, brands, and categories for a Seller Portal accountSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/catalog-api-seller-portal)[Checkout APIAccess and manipulate items and data from a checkout cart.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/checkout-api)[Customer Credit APIEnable credit payments on your store and control invoices and credit limits.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/customer-credit-api)[Gift Card APIRetrieve and update gift cards from our native Gift Card System.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/giftcard-api)[Gift Card Hub APIInteract with all Gift Card Providers registered to a store from a single point.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/giftcard-hub-api)[Gift Card Provider Protocol APIIntegrate your Gift Card API into VTEX platform.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/giftcard-provider-protocol)[VTEX Headless CMS APINo-code management system for storefront content.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/headless-cms-api)[Intelligent Search APIAssist your customers in their purchase journey, presenting results from search bar interactions.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/intelligent-search-api)[License Manager APIManage users, roles, hosts, AppKeys and AppTokens from a VTEX store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/license-manager-api)[Logistics APIManage all store logistics data by accessing warehouses, docks, pick up points, inventory, carriers and shipping rates.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/logistics-api)[Marketplace APIEnables marketplaces and sellers hosted on VTEX to perform their collaborative operations.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/marketplace-apis)[Master Data APIManage and retrieve all data entities, applications and records from the Master Data database.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/master-data-api-v2)[Orders APIReceive, process, and manage every order through our APIs.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/orders-api)[Payments Provider Protocol APIIntegrate your payment processing API into the VTEX platform,See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/payment-provider-protocol)[Payments Gateway APIGet payment data and process your transactions.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/payments-gateway-api)[Policies System APICreate promotion alarms when selling products with undesired prices and promotions.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/policies-system-api)[Pricing APICreate, retrieve and edit prices for each SKU, sales channel or price table.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/pricing-api)[Price Simulations APIConfigure custom price selectors for B2B stores.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/price-simulations)[Pricing Hub APIIntermediary between VTEX and external pricing systems for B2B context.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/pricing-hub)[Promotions & Taxes APIManage and retrieve all promotions, coupons and tax rules from a VTEX store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/promotions-and-taxes-api)[Reviews and Ratings APIAllow shoppers to submit reviews and ratings for products.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/reviews-and-ratings-api)[Search APISearch and sort products in the catalog using fulltext, category and brand search terms. Retrieve product data to custom searches and product shelves.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/search-api)[Session Manager APITrack relevant information about the client's current browsing session and integrate with several VTEX systems using a call.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/session-manager-api)[SKU Bindings APIManage SKU Bindings in your catalog.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/sku-bindings-api)[Subscriptions APIManage store's subscription rules to generate recurrent revenue and reduce bounce rate and churn.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/subscriptions-api-v3)[VTEX DO APIManage and retrieve notes or tasks related to orders from the VTEX DO task manager.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/vtex-do-api)[VTEX Shipping Network APIIntegrate your carrier with VTEX Shipping Network’s Hub.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/vtex-shipping-network-api)[VTEX TrackingManage all delivery solutions powered by VTEX Tracking service.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/docs/api-reference/tracking)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_3c857125
|
[
{
"role": "system",
"content": "You are a VTEX 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 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/faststore/atoms-list/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-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/faststore/atoms-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/faststore/atoms-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/faststore/atoms-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/faststore/atoms-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/faststore/atoms-list/updates/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-list/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-list/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/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-list/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/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-list/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/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-list/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-list/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-list/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-list/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/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-list/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-list/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/updates/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-list/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-list/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/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-list/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/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-list/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/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-list/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-list/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-list/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-list/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/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-list/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-list/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-list/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-overview)\n\nList\n\nLists group-related content. They can be ordered or unordered.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/List)\n\nThe `List` component groups related content in an organized manner, supporting both ordered and unordered formats. Typical use cases include:\n\n* Displaying product features or specifications.\n* Listing store benefits or policies (e.g., `Free shipping`, `Easy returns`, `Secure checkout`).\n\nExample\n\nCode\n\n* First item unordered list\n* Second item unordered list\n* Third item unordered list\n1. First item ordered list\n2. Second item ordered list\n3. Third item ordered list\n* First item\n* Second item\n* Third item\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { List } from '@faststore/ui' \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import '@faststore/ui/src/components/atoms/List/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### Unordered list\n\nExample\n\nCode\n\n* First item unordered list\n* Second item unordered list\n* Third item unordered list\n\n### Ordered list\n\nExample\n\nCode\n\n1. First item ordered list\n2. Second item ordered list\n3. Third item ordered list\n\n### Unordered list without marker\n\nExample\n\nCode\n\n* First item\n* Second item\n* Third item\n\n### Ordered list without marker\n\nExample\n\nCode\n\n1. First item\n2. Second item\n3. Third item\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| -------------------------- | --------------------------------- |\n| \\--fs-list-style-unordered | initial |\n| \\--fs-list-style-ordered | decimal |\n\n---\n\n## Data attributes\n\nYou can target and override `List` styles using the following data attributes:\n\n`data-fs-list`\n\n`data-fs-list-marker=\"true\"`\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| ---- | ---- | ----------- | ------- |\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/list.mdx)\n\n[Link« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-link)[LoaderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-loader)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23examples)\n\n[Unordered list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23unordered-list)[Ordered list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23ordered-list)[Unordered list without marker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23unordered-list-without-marker)[Ordered list without marker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23ordered-list-without-marker)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%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/list.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-list/docs/guides/faststore/atoms-list%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23examples)\n\n[Unordered list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23unordered-list)[Ordered list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23ordered-list)[Unordered list without marker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23unordered-list-without-marker)[Ordered list without marker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23ordered-list-without-marker)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-list/docs/guides/faststore/atoms-list%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_74ccbada
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides get and update the seller exchange window in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/configuration-section-api-quick-start-guides)\n\n[Getting an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-an-account-orderform-configuration)\n\n[Updating an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/update-an-account-orderform-configuration)\n\n[Get and update the seller exchange window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window)\n\n[Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/clear-orderform-message-field-from-cart)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/configuration-section-api-quick-start-guides)\n\n[Getting an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-an-account-orderform-configuration)\n\n[Updating an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/update-an-account-orderform-configuration)\n\n[Get and update the seller exchange window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window)\n\n[Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/clear-orderform-message-field-from-cart)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/checkout-api-overview)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/configuration-section-api-quick-start-guides)\n\n[Get and update the seller exchange window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window)\n\nGet and update the seller exchange window\n\n[Marketplace](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/integrating-with-marketplace) is the platform where products from different sellers can be offered to customers in one place. After the customer completes a purchase and the order is created, there may be scenarios in which the original seller of the product needs to be modified, for example, when their cancels the order due to an internal unavailability of product fulfillment.\n\nIn this situation, VTEX allows the marketplace to have a period of time (window), after the customer completes the purchase, to change sellers and thus avoid an order cancellation. For more information on the process of switching sellers, access the guides in the [Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/change-seller--5TBAwO2kOAMw44uyaaQMQO) and the [Developer Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/change-seller).\n\n> The default window for the change seller is **2 days**. However, you can modify the value for up to a maximum period of **30 days**.\n\nThis guide describes how to get a seller's current exchange window or update this value in a marketplace on your account.\n\n## Getting the current window to change seller\n\nTo get the window to change seller in a marketplace, you need to use the [Get window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getwindowtochangeseller) endpoint as a **GET** request. In this request, you must send the `accountname` through the URL address, as shown by the example below:\n\n**Method: GET**\n\n`https://{accountName}.{environment.com.br}/api/checkout/pvt/configuration/window-to-change-seller`\n\nAfter sending the request, the endpoint will return the response body showing the maximum current period of time (days after the customer's purchase) allowed to perform the seller exchange:\n\n`1\n\n\"4\" \n\n`\n\n## Updating the window to change seller\n\nTo update the seller's exchange window (in days), you need to use a similar request of the **Get window to change seller**, but as a **POST** request ([Update window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getwindowtochangeseller)), as shown by the example below:\n\n**Method: POST**\n\n`https://{accountName}.{environment.com.br}/api/checkout/pvt/configuration/window-to-change-seller`\n\nSee a request body example below (10 days):\n\n`1\n\n{ \n\n2\n\n \"waitingTime\": 10 \n\n3\n\n } \n\n`\n\nAfter sending the request, the endpoint will return `code 201 (Created)` and an empty response body.\n\nTo confirm that the new window to change seller have been applied to your account, access the [Get window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getwindowtochangeseller) endpoint again as a **GET** request.\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 401 - Unauthorized\n\n* **Message error example (code ORD062)**: `\"Unauthorized\"`. The credentials (API key and API token) used in this request are incorrect or not authorized to access this type of information.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD062\", \n\n5\n\n \"message\": \"Unauthorized\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"8ec4b686-435f-42ab-8cfd-89306f888c3c\" \n\n9\n\n} \n\n`\n\n### 404 - Not Found\n\n* **Message error example**: `\"The requested URL was not found on the server\"`: check that the URL data is correct.\n\n`1\n\n<body> \n\n2\n\n <h1>404 Not Found</h1> \n\n3\n\n <p>The requested URL was not found on this server.</p> \n\n4\n\n</body> \n\n`\n\nContributors\n\n2\n\n[](https://github.com/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/Checkout/white-label-sellers-selection-algorithm/get-and-update-the-seller-exchange-window.md)\n\n[Updating an account orderForm configuration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window//docs/guides/update-an-account-orderform-configuration)[Clear orderForm message field from cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window//docs/guides/clear-orderform-message-field-from-cart)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Getting the current window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window%23getting-the-current-window-to-change-seller)\n\n[Updating the window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window%23updating-the-window-to-change-seller)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window%23error-codes)\n\n[401 - Unauthorized](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window%23401-unauthorized)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window%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/white-label-sellers-selection-algorithm/get-and-update-the-seller-exchange-window.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting the current window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window%23getting-the-current-window-to-change-seller)\n\n[Updating the window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window%23updating-the-window-to-change-seller)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window%23error-codes)\n\n[401 - Unauthorized](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window%23401-unauthorized)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-and-update-the-seller-exchange-window/docs/guides/get-and-update-the-seller-exchange-window%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_8d68b4c9
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides getting a customer profile by email in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email)\n\nGetting a customer profile by email\n\nThe shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThe information added to the customer profile can be used in the shopping cart to reduce the time the customer spends at Checkout and improve their shopping experience. For more information, read [Purchasing with SmartCheckout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/smartcheckout-customer-information-automatic-fill-in--2Nuu3xAFzdhIzJIldAdtan%23purchasing-with-smartcheckout).\n\nThis guide will describe how to get client profile information using the email address registered in your store.\n\n## Getting customer profile information\n\nTo access the customer profile information, you must use the [Get client profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getclientprofilebyemail) endpoint. In this request, you must send the customer's email through the URL address, as in the example below:\n\n`https://{accountname}.{environment.com.br}/api/checkout/pub/profiles?email=test1@test2.com`\n\nAfter sending the request, the endpoint will return the response body containing the client profile information, as in the example below:\n\n`1\n\n... \n\n2\n\n{ \n\n3\n\n \"userProfileId\": \"fb542e51-5488-4c34-8d17-ed8fcf597a94\", \n\n4\n\n \"profileProvider\": \"VTEX\", \n\n5\n\n \"availableAccounts\": [], \n\n6\n\n \"availableAddresses\": [ \n\n7\n\n { \n\n8\n\n \"addressType\": \"residential\", \n\n9\n\n \"receiverName\": \"Clark Kent\", \n\n10\n\n \"addressId\": \"666c2e830bd9474ab6f6cc53fb6dd2d2\", \n\n11\n\n \"isDisposable\": false, \n\n12\n\n \"postalCode\": \"12345-000\", \n\n13\n\n \"city\": \"Metropolis\", \n\n14\n\n \"state\": \"NY\", \n\n15\n\n \"country\": \"USA\", \n\n16\n\n \"street\": \"My street\", \n\n17\n\n \"number\": \"123\", \n\n18\n\n \"neighborhood\": \"My neighborhood\", \n\n19\n\n \"complement\": null, \n\n20\n\n \"reference\": null, \n\n21\n\n \"geoCoordinates\": [ \n\n22\n\n -47.924747467041016, \n\n23\n\n -15.832582473754883 \n\n24\n\n ] \n\n25\n\n } \n\n26\n\n ], \n\n27\n\n \"userProfile\": { \n\n28\n\n \"email\": \"clark.kent@example.com\", \n\n29\n\n \"firstName\": \"Clark\", \n\n30\n\n \"lastName\": \"Kent\", \n\n31\n\n \"document\": \"12345678900\", \n\n32\n\n \"documentType\": \"cpf\", \n\n33\n\n \"phone\": \"+556199999999\", \n\n34\n\n \"corporateName\": null, \n\n35\n\n \"tradeName\": null, \n\n36\n\n \"corporateDocument\": null, \n\n37\n\n \"stateInscription\": null, \n\n38\n\n \"corporatePhone\": null, \n\n39\n\n \"isCorporate\": false, \n\n40\n\n \"profileCompleteOnLoading\": null, \n\n41\n\n \"profileErrorOnLoading\": null, \n\n42\n\n \"customerClass\": null \n\n43\n\n }, \n\n44\n\n \"isComplete\": true \n\n45\n\n} \n\n46\n\n... \n\n`\n\n> ️ Fields not completed in the customer profile will be displayed as `null`.\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 200 - OK\n\nDespite the `200` code, which indicates the success of the request, if the email used is not registered in your store or the customer profile is invalid or incomplete, the response body will not contain any customer profile information. In these conditions, the [SmartCheckout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/smartcheckout-customer-information-automatic-fill-in--2Nuu3xAFzdhIzJIldAdtan) feature cannot be used in the shopping cart.\n\n`1\n\n{ \n\n2\n\n \"userProfileId\": null, \n\n3\n\n \"profileProvider\": null, \n\n4\n\n \"availableAccounts\": [], \n\n5\n\n \"availableAddresses\": [], \n\n6\n\n \"userProfile\": null, \n\n7\n\n \"isComplete\": false \n\n8\n\n} \n\n`\n\n### 400 - Bad Request\n\n* **Message error example (code ORD002)**: `\"Invalid order form\"`. The `orderFormId` information is not valid.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD002\", \n\n5\n\n \"message\": \"Invalid order form\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"5d9f54e6-7db4-46d6-bca9-deeb278b8b98\" \n\n9\n\n} \n\n`\n\n### 404 - Not Found\n\n* **Message error example**: `\"The requested URL was not found on the server\"`: Check if the URL is correct.\n\n`1\n\n<body> \n\n2\n\n <h1>404 Not Found</h1> \n\n3\n\n <p>The requested URL was not found on this server.</p> \n\n4\n\n</body> \n\n`\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/cart-attachments-section-quick-start-guides/getting-a-customer-profile-by-email.md)\n\n[Cart Attachments« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email//docs/guides/cart-attachments-section-api-quick-start-guides)[Adding customer profile information to the cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email//docs/guides/add-customer-profile-information-to-the-cart)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\nON THIS PAGE\n\n[Getting customer profile information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23getting-customer-profile-information)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23404-not-found)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/cart-attachments-section-quick-start-guides/getting-a-customer-profile-by-email.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting customer profile information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23getting-customer-profile-information)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23404-not-found)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b8a718d2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides custom data 1 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/custom-data-1)\n\n[Add and handle custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/add-and-handle-custom-information-in-the-order)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/custom-data-1)\n\n[Add and handle custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/add-and-handle-custom-information-in-the-order)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/custom-data-1)\n\nCustom Data\n\nThis section contains articles about custom information in the order. Here you will find the following articles:\n\n* [Add and handle custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order)\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/custom-data-1.md)\n\n[Checkout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1//docs/guides/checkout-api-overview)[Add and handle custom information in the orderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1//docs/guides/add-and-handle-custom-information-in-the-order)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/custom-data-1.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_2d3b9c43
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides creating a regular order 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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-a-regular-order-from-an-existing-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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_e51045f3
|
[
{
"role": "system",
"content": "You are a VTEX 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 configure tradename to use in the organization search 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/how-to-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-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/how-to-configure-tradename-to-use-in-the-organization-search-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/how-to-configure-tradename-to-use-in-the-organization-search-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/how-to-configure-tradename-to-use-in-the-organization-search-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/how-to-configure-tradename-to-use-in-the-organization-search-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/how-to-configure-tradename-to-use-in-the-organization-search-field/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-field/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-field/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-field/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\nB2B Organizations\n\n[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/bulk-import-buyer-organizations-spreadsheet)\n\n[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)\n\n[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/enabling-an-access-control-list-acl-in-b2b-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-configure-tradename-to-use-in-the-organization-search-field/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-field/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-field/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-field/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-field/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\nB2B Organizations\n\n[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/bulk-import-buyer-organizations-spreadsheet)\n\n[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)\n\n[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/enabling-an-access-control-list-acl-in-b2b-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-configure-tradename-to-use-in-the-organization-search-field/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-field/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-configure-tradename-to-use-in-the-organization-search-field/docs/guides)\n\nB2B Suite\n\nB2B Organizations\n\n[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)\n\nHow to configure tradeName to use in the organization search field\n\nThe `tradeName` field is used to identify buyer and supplier companies on the platform. When configured as `Filterable`, the field allows users to filter data and search for companies based on their trade name. The `tradeName` is displayed as one of the identification attributes on the **Organizations** page in the VTEX Admin, enabling its use in record search and filtering.\n\nTo configure the `tradeName` field, follow the steps below:\n\n1. In VTEX Admin, go to **Store Settings** \\> **Storefront** \\> **Master Data**.\n\n\n\n1. After logging in, click **Advanced settings** as shown in the image below.\n\n\n\n1. In the Settings column, click on Data structure.\n\n\n\n1. Click **Data Entities**, find the CL row, and click the **Edit** button as shown in the image below.\n\n\n\n\n\n1. Find the **tradeName** field and click `Is filterable`.\n\n\n\n1. Click **Save**.\n\n\n\n1. Click the **Publish** button to apply the changes\n\n\n\nContributors\n\n1\n\n[](https://github.com/geisecosta)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/B2B-Suite/settings/how-to-configure-tradename-to-use-in-the-organization-search-field.md)\n\n[Bulk Import Buyer Organizations Spreadsheet« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field//docs/guides/bulk-import-buyer-organizations-spreadsheet)[Enabling an access control list ACL in B2B SuiteNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field//docs/guides/enabling-an-access-control-list-acl-in-b2b-suite)\n\nContributors\n\n1\n\n[](https://github.com/geisecosta)\n\nWas this helpful?\n\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/B2B-Suite/settings/how-to-configure-tradename-to-use-in-the-organization-search-field.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_dfbd9662
|
[
{
"role": "system",
"content": "You are a VTEX 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 composable components in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/composability)\n\n[VTEX Composable Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components)\n\n[Interactive Marchitecture tool](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/interactive-marchitecture-tool)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/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-composable-components/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/composability)\n\n[VTEX Composable Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components)\n\n[Interactive Marchitecture tool](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/interactive-marchitecture-tool)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/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-composable-components/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides)\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-platform-overview)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/composability)\n\n[VTEX Composable Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components)\n\nVTEX Composable Components\n\nLearn about the components VTEX offers to build a composable store.\n\nVarious components are available in a VTEX store to fulfill the multiple types of digital commerce businesses. This guide details each platform component and explains their composable features.\n\n\n\nIn the tables below, each component is classified by type.\n\n* **Built-in** type means that the component comes installed out-of-the-box with the VTEX store.\n* **Plug-and-play** type means that the component does not come installed, but it can be installed with a few steps and, after configuration in some cases, it will be ready to use.\n* If a component is neither **Built-in** nor **Plug-and-play**, it may require a more complex configuration or a development stage.\n\n> The specific set of components used in a store will vary based on each scenario and business model. See the [Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-architecture) guide for more details about store implementation in specific scenarios.\n\nIf you want to try composability and simulate building a store architecture, see the details in the [Interactive Marchitecture tool](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool) guide.\n\n## Commerce Platform\n\nVTEX Commerce Platform provides a set of core commerce out-of-the-box features for Digital Commerce, Experience Management, Order Management, and Marketplace Management that help merchants start their operations smoothly and efficiently.\n\n### Digital Commerce\n\n| **Component** | **Description** | **Type** |\n| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| Catalog | In the [Catalog](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/75MX4aorniD0BYAB8Nwbo7%23catalog), merchants can manage the category tree (departments, categories, and subcategories), brands, products, SKUs, and specifications. Merchants can use this module natively through the Admin or via the [Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api), import the data from a spreadsheet, or integrate it with an external back office tool. For more details, see **ERP** and **PIM/CPQ** in [Integrations](#integrations). | Built-in |\n| Price | In the [Prices module](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/75MX4aorniD0BYAB8Nwbo7%23prices), merchants can manage price details for the store's SKUs. Merchants can use this module natively through the Admin or via the [Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api), import the data from a spreadsheet, or integrate it with an external back office tool. For more details, see **ERP** and **PIM/CPQ** in [Integrations](#integrations).You can use only fixed prices or change them for different contexts including trade policies, customer groups, and promotions.You can also use [Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview), where merchants store the prices in an external platform integrated with VTEX, so they are accessed via Checkout. | Built-in |\n| Promotions | The [Promotions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/75MX4aorniD0BYAB8Nwbo7%23promotions) module manages discounts applied to customers' shopping carts in the store. It also deals with [taxes](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-surchargestaxes--tutorials%5F321). Discounts can be applied to multiple categories, such as specific products, target audiences, bundles, shipping, or coupons. Merchants can use this module natively through the Admin or via the [Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api). | Built-in |\n| Checkout | The [Checkout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/3MYcZaojb5HSUg6ufm6GxQ%23checkout) module is responsible for managing the shopping cart. It coordinates data from Catalog, Price, Promotions, Logistics, and Payments to complete the purchase process and place orders. The module offers many customization options, such as optimization of shipping options, geolocation shipping calculation, abandoned cart configuration, UI customization, and others.With the [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api), you can develop custom solutions with [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) or [headless implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-cart-and-checkout). | Built-in |\n| Payment Gateway | The [Payments](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/3MYcZaojb5HSUg6ufm6GxQ%23payments) module configures the payment conditions and deals with transactions. Within this module is our [Payment Gateway](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-payment-gateway--2KH9Wdi7F6swOU4amECSOk), which transmits the payment data using [connectors](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-the-connector--3lze0Cu0bmyC6u2o2iaeEA) from different payment providers. The VTEX Payment Gateway is mandatory but the merchant can choose their payment processing providers. For more details, see **Payments** in [Integrations](#integrations).Besides having the basic payment features, merchants can add [anti-fraud providers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-anti-fraud--69SjFCc4rC6Ii0OMAeYAsG), [Customer Credit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0), [digital wallets](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-e-wallet--4v5wcOe4A0SiaimWM2cU60), and [gift cards](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/gift-card--tutorials%5F995) to the payment experience. | Built-in |\n| Channel Management | VTEX supports [Unified Commerce Strategies](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/unified-commerce-strategies--3WGDRRhc3vf1MJb9zGncnv/2LGAiUnHES1enjHsfi8fI3) to integrate different sales channels. Merchants can sell through multiple channels, including their website, physical stores, Sales App, and more. This strategy allows all data (order processing, payment transactions, etc.) to be shared between channels and accessible from the Admin. Besides, order processing and fulfillment can be mixed across channels. For instance, the customer could place an order online and have the option to pick up specific items in a physical store, or they could make a purchase in a physical store and have it delivered to their address.Among the available sales channel options, we support [Marketplace strategies](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials%5F402), which allows merchants to sell products on marketplaces, or for their store to become a marketplace and sell products from sellers. | Built-in |\n| B2B Organizations | [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations) is a [VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app) from the [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite). It enables merchants to group B2B (Business-to-Business) users into organizations and apply specific custom payment methods, product selections, and prices for customers from the same organization. Each organization is further segmented into one or more cost centers, with their shipping addresses, which will be available to cost center users at checkout. | Plug-and-play |\n| B2B Quotes & Carts | [B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes) is a [VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app) from the [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite). It allows B2B users to create quotes and save carts, which can then be shared with other members of their organization. This enables price negotiations between customers and the store’s sales associates, and streamlines order approval flows within their organization. | Plug-and-play |\n\n### Experience Management\n\n| **Component** | **Description** | **Type** |\n| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |\n| Headless CMS | [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) is part of our [FastStore toolkit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore). It allows merchants to store content in a decoupled data layer and deliver it as structured data to a VTEX store with FastStore via API. | Requires implementation |\n| Intelligent Search | [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG) is a native VTEX platform search solution, working regardless of the channel (website, mobile app, conversational, etc.). Its features include autocomplete, filters, synonyms, and relevance rules. To add Intelligent Search to a store, install the [Search app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search).Besides Intelligent Search, you can integrate third-party search solutions into a VTEX store. For more details, see **Search & Personalization** in [Integrations](#integrations). | Plug-and-play |\n| Storefront Application | VTEX offers alternatives for storefront applications. For [website frontend implementation](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/67SCtUreXxKYWhZh8n0zvZ), options include [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). Merchants can also build a complete custom solution, e.g., a custom mobile app, using our [APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference). | Requires implementation |\n| PWA Application | Progressive Web Application (PWA) is natively available for every VTEX IO store. Merchants can configure a push notification to install the store’s PWA on the customer’s device. For more details, see [Enabling PWA push notifications in your store](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/enabling-pwa-push-notifications-in-your-store--1be3ZPhbsgZSbE7h5H46pG). | Built-in |\n\n### Distributed Order Management\n\n| **Component** | **Description** | **Type** |\n| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |\n| Inventory Management | [Inventory management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-stock-items--tutorials%5F139) is a page in the Admin where merchants can view SKU (Stock Keeping Unit) inventory data and define SKU quantities in [warehouses](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).Also, merchants can [import inventory data](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu%23inventory) from spreadsheets or via the [Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api), which allows integration with external tools. For more details, see **ERP**, **OMS/WMS**, and **PIM/CPQ** in [Integrations](#integrations). | Built-in |\n| Logistics | The [Logistics](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/75MX4aorniD0BYAB8Nwbo7%23logistics) module manages the transportation and storage of merchandise, as well as order shipping to customers. The main set of configurations in Logistics is the Shipping strategy, which comprises shipping policies, warehouses, and loading docks.Merchants can make all the configurations in the Admin or via the [Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api), which allows integrations with external tools. For more details, see **ERP**, **OMS/WMS**, and **PIM/CPQ** in [Integrations](#integrations).Also, merchants can choose their carriers in the [shipping policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/shipping-policy--tutorials%5F140). For more details, see **Carriers** in [Integrations](#integrations). | Built-in |\n| Shipping Network | [VTEX Shipping Network](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shipping-network-dashboard--51e8tx1IehiN4ZtURRWU92) is an [add-on](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/next-steps-after-the-go-live--3J7WFZyvTcoiwkcIVFVhIS/1t2QBZvrOBSLgvHaAV9fYm) that offers the option of connecting carriers to create an integrated delivery network. It gathers order tracking data directly from these carriers, keeping merchants and their customers up to date. The Admin dashboards show a managerial overview of shipping costs and revenue generated from shipping rates.⚠️ _This feature is only available in Brazil._ | Plug-and-play, upon subscription/additional costs |\n\n### Marketplace Management\n\n| **Component** | **Description** | **Type** |\n| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |\n| Seller Management | [Seller Management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/seller-management--6eEiOISwxuAWJ8w6MtK7iv) is a VTEX Admin page where marketplace operators can [add sellers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/adicionar-seller--tutorials%5F392), enter their information, and manage their status, allowing marketplaces to assess their operation. It supports both VTEX sellers with a VTEX account, and external sellers integrated with VTEX. For more details, see **Third-party Sellers** in [Integrations](#integrations). | Built-in |\n| Offer Quality & Management | The [Offer Management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/offer-management--7MRb9S78aBdZjFGpbuffpE) module allows sellers to track the sending and syncing of their offers on all sales channels integrated with the store in the Admin. On VTEX, an offer is a SKU from a seller that has been sent to a sales channel with price and inventory information configured.It allows tracking offers sent to the following channels: [Mercado Libre](https://read.calvincode.net/reader?url=https://help.vtex.com/es/tracks/mercado-libre-integration-set-up--2YfvI3Jxe0CGIKoWIGQEIq/51oWBHvVxSs8eAwLQhSbSd), [Netshoes](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tracks/configurar-integracao-da-netshoes--5Ua87lhFg4m0kEcuyqmcCm), and [VTEX marketplaces](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials%5F402%23being-a-vtex-marketplace). Other marketplaces can add support to Offer Management in their connectors by using the [Offer Management API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management) and following the [Offer Management integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors). [Offer Quality Filters](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/offer-quality-filters--4xm0gi8leCyxHj8YdgHSJH) is an Admin page where marketplaces add and manage the rules that will be applied to the received SKU cataloging process. Marketplaces can create and apply mandatory and optional rules on this page to filter the sellers’ offers. | Built-in |\n| Seller Portal | [Seller Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/seller-portal-getting-started-for-the-marketplace--6ccErY3mCcfoW0qGXf167) is an edition of the VTEX platform for VTEX or third-party sellers to connect and sell their products on marketplaces. The portal provides sellers with essential capabilities for ecommerce operations, such as catalog, prices, logistics, and order management. It also has a dashboard that shows sales performance and allows ERP integration.We also have the [Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app), which allows VTEX marketplaces to create a customized Seller Portal. | Built-in |\n| Marketplaces and Integrations | [Marketplaces and Integrations](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplaces-and-integrations--5AcBO1t29nhq7rBHas9b6V), previously known as Marketplace Network, is a page in the Admin with a catalog of companies interested in partnerships. This page enables integration between marketplaces and sellers to sign commercial agreements. Both VTEX and external marketplaces are available.VTEX marketplaces are VTEX clients that choose to make their environment available for sellers to sell products. After a merchant [configures their VTEX store to operate as a marketplace](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-vtex-marketplace--7splyp5MqIyt2Iyz5jsNzb), it will be available for sellers to connect on the **Marketplaces and Integrations** page.External marketplaces are marketplaces that are not VTEX clients, and after [developing a connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide) to integrate with VTEX, they become available for sellers to connect on the **Marketplaces and Integrations** page. For more details, see **Third-Party Marketplaces** in [Integrations](#integrations). | Built-in |\n\n## Platform interaction\n\nMerchants can interact with a VTEX store in two ways: VTEX Admin and Developer Tooling. Learn more about their components in the following sections.\n\n### VTEX Admin\n\nThe VTEX Admin is a panel for managing the entire digital commerce experience in one place. The [Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-admin-start-here--531cHtUCUi3puRXNDmKziw) provides a complete out-of-the-box feature set, including pages with dashboards, settings, and detailed information from our [core modules](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/75MX4aorniD0BYAB8Nwbo7). In the Admin, merchants can manage catalog, prices, and inventory, add payment options, and view transactions, order status, customer data, sales performance, among others. Adding new features to the store through the Admin is also possible via the Extensions Hub.\n\n| **Component** | **Description** | **Type** |\n| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |\n| Dashboards | [Dashboards](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/dashboards-overview--1yn2nZUoXtDO3teTEJsCNl) is a section in the Admin that centralizes the dashboard pages and display analytical data for the store’s unified commerce. Three dashboards are available:[Overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/store-overview--P8ahguoRs0U3PzmXg2wuQ): Shows key metrics that impact store revenue. It has charts about the evolution of sales, conversion rate, and sales funnel.[Sales Performance](https://read.calvincode.net/reader?url=https://help.vtex.com/en/v4/docs/sales-performance--6gx46RGRzWO8qgaVck7PRp): Shows and analyzes order data from stores and sellers, useful for stores that [operate as marketplaces](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials%5F402%23acting-as-a-marketplace).[Web Page Performance](https://read.calvincode.net/reader?url=https://help.vtex.com/en/v4/docs/web-page-performance--7DeyhX8cGtG9PtAGkL8zvc): Uses [Google's PageSpeed Insights](https://read.calvincode.net/reader?url=https://developers.google.com/speed/docs/insights/v5/about) tool to track the performance of the store’s URLs. | Built-in |\n| Releases | [Releases](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/planner-release-concept-beta--4pWhQTXG0aIIsi2TYxxRkZ) is a [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore) feature that allows the efficient management of store changes. A release is a change or a group of changes that can be published together. This feature includes two pages:[Releases](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/planner-releases-page-beta--2p7IiVD6K8i1iRiwHph5sw): This page lists all existing releases. It allows several [actions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/planner-actions-on-releases-beta--1zsomdifPEQkdV6RW93JyW), including creation, scheduling, publishing, and deleting releases.[Calendar](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/planner-calendar-page-beta--46wSZ7Z5xoXQPP0xHfIx9C): This page shows a calendar of releases by month, week, or day. It allows merchants to see the releases on their publication date or time, access their details, and create new releases. | Built-in, after installing FastStore |\n| User & Account Management | The [Account page](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/account-management--2vhUVOKfCaswqLguT2F9xq) allows merchants to view and manage their VTEX account details, such as the company’s logo, trading name, legal name, and the stores in the account.On the [Users page](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/managing-users--tutorials%5F512), merchants can view and manage Admin users. When creating or editing users, merchants can choose their [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc), which define what a user can access. | Built-in |\n| Extensions Hub | On VTEX, extensions are tools designed to expand VTEX’s stores out-of-the-box capabilities. Extensions include [VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app), [payment connectors](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-the-connector--3lze0Cu0bmyC6u2o2iaeEA), [marketplace integrations](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/integrating-with-marketplace), and others. The [Extensions Hub](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/extensions-hub--AW7klkYMh557y5IUOgzco/3lWdpzjyhHVwzMC7pTG0QS) is a section of the Admin that centralizes extension management. It has the following pages:**App Store:** A page where merchants can find and acquire apps, adding features to their stores. Apps can be free of charge or paid, and developed by VTEX or by [implementation partners](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/4yPqZQyj0t675QpcG7H6yl%23implementation-partners).**App Management:** This page shows the apps installed in the account and allows merchants to install, configure, uninstall, and delete apps. | Built-in |\n\n### Developer Tooling\n\nVarious tools are available for creating new features on the VTEX platform. Development can be done by the merchant’s tech team or by [partner agencies](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/4yPqZQyj0t675QpcG7H6yl%23implementation-partners). VTEX offers many possibilities for building new features, including apps and storefront features using [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io), custom behaviors with data in [Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw), and [integrations](#integrations) using our [APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference), which extend VTEX’s out-of-the-box features.\n\n| **Component** | **Description** | **Type** |\n| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |\n| VTEX IO Storefront Platform | VTEX uses the following technologies for [storefront development](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/67SCtUreXxKYWhZh8n0zvZ%23frontend-development-technologies-on-vtex):[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework): A technology framework for storefront implementation focused on the composable commerce model. It allows combining different VTEX IO apps to build a storefront. With this technology, the store's implementation is based on pre-built components, also known as blocks, and components are customized to meet specific business needs. This framework is based on React, TypeScript, Node.js, and GraphQL.[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore): Our latest storefront technology to create stores focused on performance and stability. It is an open-source toolkit based on [React](https://read.calvincode.net/reader?url=https://react.dev/) and the [Jamstack](https://read.calvincode.net/reader?url=https://jamstack.org/) architecture. It offers many features to enhance the development experience, including a starting template, headless technology, Admin UI panels for management, and integration with GitHub. | Built-in |\n| APIs | VTEX is an API-first platform with over 750 endpoints. [VTEX REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) allow interaction with over 70 microservices to build custom solutions, such as [integrations](#integrations) and [VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app). Using our APIs requires [Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication) with keys or tokens for users and integrations. IO apps can use the APIs through [clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients). See our [API guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides) for details on how to use our APIs for specific scenarios. | Built-in |\n| Master Data Management | [Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw) is a VTEX highly customizable database platform. It allows merchants to store, search, expand, and customize data. There are two versions available: v1 and v2\\. The main differences are that v1 has a graphical interface, and v2 uses [JSON schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-json-schemas-in-master-data-v2) for structuring data. [Master Data’s API](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/master-data-api-v2-overview) enables integration with external systems and applications, such as IO apps.Master Data has a [trigger](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23triggers) mechanism that allows custom behaviors with data interaction. For instance, merchants can configure to send an email or an HTTP request when a customer's data changes. | Built-in |\n| VTEX IO App Platform | [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) is a development platform with high-performance management, scalability, and robust security. It offers the tools to develop, manage, install, and deploy [apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app), allowing the creation of custom solutions to extend the VTEX platform capabilities. Many app types are available for different scenarios, including storefront themes and components, Admin apps, and backend services.VTEX offers a wide range of [readily available apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps) that merchants can install and developers can use as [dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-dependencies).Developers can [make their apps publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store) in the [App Store](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/extensions-hub--AW7klkYMh557y5IUOgzco/2LDRvGujYsumxi7IlE7CEJ), enabling merchants to install these apps on their stores.See our [Developer Experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience) guide and [Extensions and apps overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu%23extensions-and-apps) for more details about developing and using IO apps. | Built-in |\n\n## Integrations\n\nIntegrations allow external providers to integrate their solutions with VTEX stores by leveraging [VTEX APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference). Many integrations are readily available from our partner ecosystem. Merchants just need to install and configure them before use. You can also develop new integrations by following our integration guides or request this service from our [partners](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/4yPqZQyj0t675QpcG7H6yl%23implementation-partners).\n\nFor more information about how integrations work, see our [Backend integrations overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu) and the **Integration Guides** section in our [Developer Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides).\n\nThe types of integrations available on VTEX are:\n\n| **Component** | **Description** | **Type** |\n| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |\n| ERP | ERP (Enterprise Resource Planning) is the main back office software that manages essential parts of the operation related to Catalog, Pricing, Logistics, and Orders.Some parts of the operation that an ERP deals with can be delegated to other software types: A **WMS** can manage Logistics, a **PIM** can manage Catalog, and a **CPQ** can manage Pricing. See the details about integration with these software types in the table below.An ERP system integrates with VTEX to exchange data and give commands. These integrations are implemented using the APIs from each module ([Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api), [Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api), [Logistics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api), and [Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api)). The integration is done in two phases, an initial setup for importing product-related data and a middleware setup for configuring order processing.Merchants can choose which ERP system to use with VTEX and which parts of their operation to integrate. Some ERPs on the market already have an integration implemented with VTEX, so merchants only need to configure through the UI. Otherwise, the integration must be developed by the merchant technical team or an [implementation partner](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/4yPqZQyj0t675QpcG7H6yl%23implementation-partners).For details about implementing ERP integrations, see **ERP integration** in our [Backend integrations overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu%23erp-integration) and our [Back office integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide) guide. | Plug-and-play if the ERP integration is implemented. Requires implementation otherwise. |\n| OMS/WMS | OMS (Order Management System) is a tool designed to handle order processing. VTEX has its own OMS but merchants can integrate external software, usually an ERP system, with the [Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api) to receive order events and handle order processing. There are two types of order integrations for receiving order events:Feed: The external software reads a queue of order events.Hook: The external software receives automatic notifications about order updates.After receiving an event, the external software handles the order with various possible actions, such as changing, canceling, invoicing, and tracking an order during handling, and then returns the result to VTEX’s OMS. For details about implementing integrations with our OMS, see **Middleware configuration**, **Order integration**, and **Order Processing** in our [Backend integrations overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu), [Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed), [Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration), and [Setup order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing) guides.WMS (Warehouse Management System) is a back office software responsible for managing the operation’s inventory and logistics. On VTEX, integrations with this software send inventory data (warehouses and SKU quantities). For more details, see **Inventory** in our [Backend integrations overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu%23inventory), and our [Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-inventory) guide. | Plug-and-play if the OMS/WMS integration is implemented. Requires implementation otherwise. |\n| PIM/CPQ | PIM (Product Information Manager) is a back office software that deals with catalog and product data. On VTEX, PIM integrations can send information about the [category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories%23category-tree), brands, products, SKUs, and specifications using the [Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api). For more details, see **Catalog architecture** and **Importing products** in our [Backend integrations overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu), [Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog), and [Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products) guides.CPQ (Configure Price Quote) is a back office software that manages product prices. On VTEX, CPQ integrations can send pricing information via the [Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api). For more details, see **Prices** in our [Backend integrations overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu%23prices), and our [Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices) guide. | Plug-and-play if the PIM/CPQ integration is implemented. Requires implementation otherwise. |\n| CRM | CRM (Customer Relationship Management) is a software that helps track information and interactions between a company and its customers. On VTEX, customer data is usually stored in [Master Data v1](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw). CRM integrations can send customer data (name, email, address, ID number, etc.) to VTEX using the [Master Data v1 API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api). For more details, see **Customer data** in our [Backend integrations overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu%23customer-data), and our [Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data) guide.For more details, see **Customer data** in our [Backend integrations overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu%23middleware-configuration), and our [Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data) guide. | Plug-and-play if the CRM integration is implemented. Requires implementation otherwise. |\n| Third-Party Marketplaces | VTEX [sellers](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-a-seller--5FkLvhZ3Few4CWWIuYOK2w) can offer their products on VTEX and third-party/external [marketplaces](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-marketplace--680lLJTnmEAmekcC0MIea8). See the list of external marketplaces available at [Marketplace strategies at VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/estrategias-de-marketplace-na-vtex--tutorials%5F402%23integrating-with-a-certified-marketplace).For marketplaces not integrated with VTEX but wishing to offer products from VTEX sellers, a custom connector can be developed for this integration. VTEX provides a set of APIs and instructions to facilitate the process. For more information, see our [External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide) integration guide. | Plug-and-play if the marketplace integration is implemented. Requires implementation otherwise. |\n| Search & Personalization | By default, VTEX offers [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG) as a search engine, but merchants can use other search solutions instead. Our [Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-integration-guide) enables third-party search solutions to integrate with VTEX. Stores can easily switch between search providers without changes in the storefront.At its core, the Search Protocol is a set of definitions and GraphQL schemas that allows IO apps to serve ecommerce search results that can be used by the [VTEX Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework).For plug-and-play implementation of pre-integrated solutions, you can find search provider apps on the [App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com). | Plug-and-play if the search integration is implemented. Requires implementation otherwise. |\n| Marketing & Analytics | Marketing & Analytics integrations are provided as VTEX IO apps. Marketing integrations allow stores to connect with marketing platforms and attract customers. Analytics integrations collect and process customer session data. Check out the available apps for [Marketing and affiliate programs](https://read.calvincode.net/reader?url=https://apps.vtex.com/all-apps%23marketing) and [Reviews, ratings, and analytics](https://read.calvincode.net/reader?url=https://apps.vtex.com/all-apps%23review) on the App Store.If the integration is not implemented, a [Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps) can be developed. This type of app runs scripts on all pages of a store website and natively integrates the store with a third-party solution, such as sales tracking, user support, and marketing services. | Plug-and-play if the marketing/analytics app is implemented. Requires implementation otherwise. |\n| Payments | Payment integrations allow payment providers to operate in VTEX stores. If a payment provider is integrated, the merchant must have a contract with the provider and configure the payment options through the VTEX Admin. See the details in the **Payments** section of our [VTEX modules overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/3MYcZaojb5HSUg6ufm6GxQ%23payments). Find the providers supported by VTEX in the [List of Payment Providers by Country](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/list-of-payment-providers-by-country--2im3BEGXxSAcRuxEaIHPvp).If a payment provider is not integrated, the payment company or an [implementation partner](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/4yPqZQyj0t675QpcG7H6yl%23implementation-partners) can develop an integration, also called a [connector](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-the-connector), following our [Payment Provider Protocol](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m). The connector implementation must have the endpoints described in the [Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol) and will be called by the VTEX’s Payment Gateway. The protocol is flexible enough to support the implementation of various payment [methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods), [conditions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-configure-payment-conditions--tutorials%5F455), and [purchase flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows). For more details, see [Integrating a new payment provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex). | Plug-and-play if the payment provider is implemented. Requires implementation otherwise. |\n| Carriers | [Carriers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE) are companies that deliver orders to customers. The standard way to add carriers to VTEX is by [creating shipping policies](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-a-shipping-policy--66rJO4LKBdyMJOH6Z3dsaT) in the Logistics module. Another option is to use the [VTEX Shipping Network](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shipping-network-dashboard--51e8tx1IehiN4ZtURRWU92) add-on, which supports over 20 carrier partners. Also, there are dedicated carrier apps in the [App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/all-apps%23omnichannel).⚠️ _VTEX Shipping Network is only available in Brazil._ | Plug-and-play |\n| Third-party Sellers | For [sellers](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-a-seller--5FkLvhZ3Few4CWWIuYOK2w) not integrated with VTEX but wishing to sell their products on a VTEX marketplace, a custom connector can be developed for this integration. VTEX provides a set of APIs and instructions to facilitate the process. For more information, see our [External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide) integration guide. | Requires implementation |\n\n## Add-ons\n\nAdd-ons are additional solutions offered by VTEX to meet specific business needs, which can be purchased separately through a subscription agreement. You can find more details on [Add-on products](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/next-steps-after-the-go-live--3J7WFZyvTcoiwkcIVFVhIS/1t2QBZvrOBSLgvHaAV9fYm). Some add-ons available at VTEX are:\n\n| **Component** | **Description** | **Type** |\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- |\n| Sales App | [VTEX Sales App](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc/7fnnVlG3Kv1Tay9iagc5yf) is our main solution for [Unified Commerce](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/unified-commerce-strategies--3WGDRRhc3vf1MJb9zGncnv) operations. It includes a mobile app that enables sales associates from physical stores to serve customers and complete the entire sales process, from helping to choose the right products to payment and delivery. | Plug-and-play, upon subscription/additional costs |\n| Live Shopping | The [Live Shopping](https://read.calvincode.net/reader?url=https://vtex.com/us-en/live-shopping) app enables an interactive ecommerce experience that combines livestreaming and online shopping. Its key features include real-time interaction, personalized content, and data analytics for performance tracking. Events with Live Shopping lead to increased engagement, add-to-cart ratio, and conversion rates. | Plug-and-play, upon subscription/additional costs |\n| Personal Shopper | [VTEX Personal Shopper](https://read.calvincode.net/reader?url=https://vtex.com/us-en/vtex-personal-shopper/) is an app used by sales associates that brings the physical store shopping experience to the digital environment. It offers one-to-one video chats with customers, enabling product demonstration, real-time answers to queries, and direct addition of products to the cart. | Plug-and-play, upon subscription/additional costs |\n| Assisted Sales (SuiteShare) | [Assisted Sales (SuiteShare)](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tracks/suiteshare--khP0p8mjIYRIpvM7Cb4Zr), previously known as Conversational Commerce, is a marketing platform for WhatsApp, helping to attract more clients, capture customer data, and integrate with sales tools. The platform allows for organizing customer support, integrating with major CRMs, and measuring results. The solution is based on the [official WhatsApp API](https://read.calvincode.net/reader?url=https://developers.facebook.com/docs/whatsapp/cloud-api). | Plug-and-play, upon subscription/additional costs |\n| Pick and Pack | [VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-pick-and-pack--1OOops3WrUyz7e0bnhkfXU) helps merchants manage the order fulfillment process, including picking, packing, and delivery, from physical stores and warehouses to customers' addresses or pickup points. It provides real-time tracking, route optimization, and data analytics to improve efficiency and performance. The solution consists of:Fulfillment: Admin app for store operators to manage orders in the store or warehouse.Last Mile: Admin app for store operators to instruct drivers on the delivery, and access proof of collecting and delivering.Mobile Applications: Applications for mobile devices used by pickers and drivers in fulfillment. | Plug-and-play, upon subscription/additional costs |\n| VTEX Shield | [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh) offers additional, customizable protection layers for stores prioritizing platform resilience and the security standards guaranteed by VTEX's existing security certifications and practices. | Plug-and-play, upon subscription/additional costs |\n| Ad Network | [VTEX Ad Network](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-ad-network-beta--2cgqXcBuJmXN2livQvClur) connects VTEX stores with brands interested in advertising their products. This connection allows advertisers and merchants to boost their business. | Plug-and-play, upon subscription/additional costs |\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Platform-Overview/Composability/vtex-composable-components.md)\n\n[Composability« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components//docs/guides/composability)[Interactive Marchitecture toolNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components//docs/guides/interactive-marchitecture-tool)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Commerce Platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23commerce-platform)\n\n[Digital Commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23digital-commerce)[Experience Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23experience-management)[Distributed Order Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23distributed-order-management)[Marketplace Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23marketplace-management)\n\n[Platform interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23platform-interaction)\n\n[VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23vtex-admin)[Developer Tooling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23developer-tooling)\n\n[Integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23integrations)\n\n[Add-ons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23add-ons)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Platform-Overview/Composability/vtex-composable-components.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Commerce Platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23commerce-platform)\n\n[Digital Commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23digital-commerce)[Experience Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23experience-management)[Distributed Order Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23distributed-order-management)[Marketplace Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23marketplace-management)\n\n[Platform interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23platform-interaction)\n\n[VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23vtex-admin)[Developer Tooling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23developer-tooling)\n\n[Integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23integrations)\n\n[Add-ons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components/docs/guides/vtex-composable-components%23add-ons)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_ad6433ea
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides order modifications in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/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/order-modifications/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/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/order-modifications/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/actions-orders)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/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/order-modifications/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/order-modifications/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/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/order-modifications/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/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/order-modifications/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/actions-orders)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/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/order-modifications/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/order-modifications/docs/guides)\n\nOrders\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-modifications)\n\nOrder modifications\n\nOrder modification is a feature that allows your store to modify the items or prices of an order. With this feature, the store can handle potential changes in orders due to customer mistakes, product unavailability, and the inclusion of discounts, among other reasons. Learn more about how it works and its restrictions in the article [Changing items from a completed order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/changing-items-from-a-complete-order--tutorials%5F190).\n\n> We recommend that you use the [Create order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/order-system/orders/-changeOrderId-/changes) endpoint to modify an order.\n\n> The [Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/order-system/orders/-changeOrderId-/changes) feature is not applicable to the Catalog API - Seller Portal.\n\n> Learn more about [Order replacement](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-replacement--2IK9mwQjBKseQmE8K8saO8) and how to enable your customers to request order changes.\n\n## Implementation\n\nThe [Register modifications on order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/changes) endpoint in the Orders API allows you to create a discount, change an item, or increase the price of an order.\n\n> When removing or adding items to an order, the inventory of the affected SKUs is not updated automatically. You should update it [using the Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-).\n\nModifications made this way can be confirmed using the `changesAttachment` field in the response of the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) endpoint. Alternatively, you may search for the order in the **Orders > Orders management > All orders** section of your Admin panel and see the item modification history in the order details.\n\n> Increasing the price of an order is only available for credit card purchases. The connector must also be able to handle purchases without the CVV, as well as duplicate sequences.\n\n### Errors in Change v1\n\nSee below which API errors can be returned when attempting to [modify an order via Change v1 API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/changes) and how to avoid or work around them.\n\n#### Request errors\n\nThese errors happen when there are one or more errors in the information sent in the request.\n\n| Error | Description |\n| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| The modification value needs to be greater or equal than zero | discountValue or incrementValue is less than 0. |\n| Invalid modification for order | All of these conditions are true: \\- incrementValue is equal to discountValue. \\- itemsAdded is empty. \\- itemsRemoved is empty. |\n| Invalid id for item | The request body contains either an itemsAdded or itemsRemoved object that has an empty id. |\n| Field reason not set | Empty reason field. |\n\n#### Restriction errors\n\nThese are errors returned when the request is correct but the order cannot be modified due to [order change restrictions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/changing-items-from-a-complete-order--tutorials%5F190%23restrictions).\n\n| Error | Description |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| It is only allowed to register an order modification when the order is in handling: status = handling, waiting for fulfillment or ready for invoicing | The fulfillment order is not in a status that allows changes (handling, waiting for fulfillment and ready-for-invoice). |\n| It is not allowed to make modifications to chain orders | The order has a chain origin. |\n| It is only allowed to register a modification in the order when the payment is approved - status = payment-approved | The marketplace order is not in the status payment-approved. |\n| The value of the modification exceeds the order's price | discountValue is greater than the total order price. |\n| Impossible cancel order {0} - Payment not found | Order is complete, but transaction id is empty or null. |\n| Workflow not found for order {0} | Order has an empty or null workflowInstanceId. |\n| Max allowed modifications for order exceeded: {0} | More than 50 registered modification requests for a single order. |\n| 404 Not Found | At least one of these conditions is true: \\- The removed item does not exist in the order. \\- The added item does not exist in the catalog. |\n| Invalid quantity to remove from item {0} | An item's quantity would be reduced to less than 0 after the modification. |\n| It's not allowed to make modifications in orders without a credit card payment, promissory card, cash, or credit control | All of these conditions are true: \\- An attempt to increase order price was made. \\- The payment method does not support value changes. \\- The payment method is not credit card payment, promissory card, cash, or credit control. Consult your payment gateway to see which methods allow for order value changes. |\n| Modification cannot be done. Possible reason: settlement directly done by API | All of these conditions are true: \\- An attempt to reduce order price. \\- The payment method does not support value modifications. Consult your payment gateway to see which methods allow for order value modifications. |\n| The value of the modification exceeds the order's price | discountValue is greater than the amount allowed for the order transaction. |\n| 500 Internal Server Error | There is an issue with the payment gateway. |\n\n### Errors in Change v2\n\nSee below which API errors can be returned when attempting to [modify an order via Change v2 API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/changes) and how to avoid or work around them.\n\n#### Errors with exception codes\n\n| Error code | Error message | Description |\n| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| CHK0022 | Invalid id for item. | The item id is not valid or does not exist. |\n| CHK0023 | Invalid quantity for item. | The item quantity is not allowed (e.g., less than 1). |\n| CHK0034 | The value of the change exceed the order's price. | The modification value is greater than the total order price. |\n| CHK0095 | Changes in chain orders are not allowed. | Chain orders do not support modifications. |\n| CHK0096 | Change cannot be done. Possible reason: settlement directly done by API. | The change operation is not allowed, possibly due to a direct settlement. |\n| CHK0098 | The change value needs to be greater or equal than zero. | The value for the change operation must not be negative. |\n| CHK0124 | Invalid change for order. | The requested modification is not valid for the current order state or data. **Allowed order states for order modification:** handling, waiting-for-fulfillment, and ready-for-invoicing. |\n| CHK0196 | Cannot cancel order {0} - Payment not found. | The order cannot be canceled because no payment was found. |\n| CHK0199 | OrderGroup {0} not found. | The order group does not exist. |\n| CHK0201 | Order {0} not found. | The order does not exist. Please verify the order ID in your operation. |\n| CHK0229 | Workflow not found for order {0}. | No workflow was found for the order. |\n| CHK0289 | Change order request {0} not found. | The modification order request does not exist. |\n| CHK00342 | Change order cannot increase the value for this payment method. | Increasing the order value is not allowed for the selected payment method. |\n| SalesOrderSystem008 | Cannot Change Cancelled Order. | Changes cannot be made to orders that have already been canceled. |\n| SalesOrderSystem010 | It's not possible to remove the item of ID {0} from the original order. Validate your {1} operation items IDs. | The specified item id cannot be removed from the original order. Please verify the item id in your operation. |\n| SalesOrderSystem011 | It's not possible to remove more than {0} quantities of the item of ID {1} from the original order. Validate your items quantities at Remove or Replace From operations. | The quantity being removed exceeds the quantity available in the order. Please verify the item quantity in your operation. |\n| SalesOrderSystem012 | The logistics information couldn't be determined for the item due to the presence of multiple options. | The order contains multiple logistics options, so the system cannot infer which one to use. Please verify the logisticsInfo field in your operation. |\n| SalesOrderSystem013 | The logistics information provided was not found on the order. | The logistics details given do not match any information in the order. Please verify the logisticsInfo field in your operation. |\n| SalesOrderSystem014 | Change In Progress. | A change operation is currently in progress for this order. You can try making a new operation once the change in progress is finalized. |\n| SalesOrderSystem015 | A Change V1 has already been applied to this order. Orders can only contain one Change Order version at a time. | Only one type of order change (v1 or v2) can be applied. A v1 change already exists. |\n| SalesOrderSystem016 | Cannot Retry Change. | The change operation cannot be retried since the workflow status is done or canceled. |\n| SalesOrderSystem017 | Change process was automatically canceled after failed retries. | The modification was canceled by the system after several failed retry attempts. You should use the [Create order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) endpoint. |\n| SalesOrderSystem018 | Unable to communicate with Participants Client. | The system could not reach the Participants Client service. |\n| SalesOrderSystem019 | Cannot Update Change Order Settings. | Settings are being updated by another request. You can try again later. |\n| SalesOrderSystem026 | Unable to match an item to the information provided. Try providing the item's uniqueId for identification. | The item could not be identified with the given data. Try using the item's uniqueId. |\n| SalesOrderSystem027 | Change Settings Not Found. | Change order settings could not be found for this configuration. |\n| SalesOrderSystem029 | Cannot Add New Products At Change Order When Order Has Multiple Address. | When the order has multiple delivery addresses, you can only modify the existing items, not add new ones. |\n| SalesOrderSystem035 | The {0} is not a valid Agreement Type. | The agreement type is not recognized or supported. **Allowed:** Acknowledgment or Confirmation. |\n| SalesOrderSystem045 | Invalid address. | The address is invalid. Please verify the addressId field in your operation. |\n| SalesOrderSystem046 | The order change is not allowed after the item invoice has been issued. | Order modification is not allowed after the invoice has been issued. |\n| SalesOrderSystem047 | The address change is not allowed. | The address modification is not allowed. |\n| SalesOrderSystem048 | The address change is not allowed when there are packages associated. | The address modification is not allowed when there are packages associated. |\n| SalesOrderSystem051 | Change order not allowed with tax hub and multiple delivery docks. | Order modification is not allowed with tax hub and multiple delivery docks. |\n| SalesOrderSystem055 | Item modification is not allowed when the measurement unit differs from the original. | Item modification is not allowed when the measurement unit differs from the original. To change the measurement unit, try using the replace array and modifying its to and from objects. |\n\nContributors\n\n2\n\n[](https://github.com/mariananantua)\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md)\n\n[Feed v3« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications//docs/guides/orders-feed)[Change sellerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications//docs/guides/change-seller)\n\nContributors\n\n2\n\n[](https://github.com/mariananantua)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-modifications%23implementation)\n\n[Errors in Change v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-modifications%23errors-in-change-v1)[Errors in Change v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-modifications%23errors-in-change-v2)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-modifications%23implementation)\n\n[Errors in Change v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-modifications%23errors-in-change-v1)[Errors in Change v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-modifications/docs/guides/order-modifications%23errors-in-change-v2)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0e9348e9
|
[
{
"role": "system",
"content": "You are a VTEX 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 product title in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-product-title/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-product-title/docs/api-reference)\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-product-title/docs/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-product-title/docs/storefront-development)\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-product-title/docs/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-product-title/docs/troubleshooting)\n\n[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-product-title/updates/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-product-title/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-product-title/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/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-product-title/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/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-product-title/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/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-product-title/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-product-title/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-product-title/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-product-title/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/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-product-title/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-product-title/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/updates/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-product-title/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-product-title/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/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-product-title/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/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-product-title/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/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-product-title/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-product-title/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-product-title/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-product-title/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/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-product-title/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-product-title/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-product-title/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-overview)\n\nProductTitle\n\nWraps the product name, a product label and the rating.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/ProductTitle)\n\nThe `ProductTitle` is a component commonly used on Product Details Page (PDP). It wraps the product name, a product label and the rating.\n\nExample\n\nCode\n\n# Apple Magic Mouse\n\n10% off\n\nRef.: 99995945\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { ProductTitle } 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/ProductTitle/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\n# Apple Magic Mouse\n\n10% off\n\nExample\n\nCode\n\n# Handmade Steel Pants Gorgeous\n\n10% off\n\nExample\n\nCode\n\n# Handmade Steel Pants Gorgeous\n\n10% off\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ------------------------------- | --------------------------------- |\n| \\--fs-product-title-text-size | var(--fs-text-size-title-product) |\n| \\--fs-product-title-text-weight | var(--fs-text-weight-regular) |\n| \\--fs-product-title-line-height | 1.12 |\n| \\--fs-product-title-column-gap | var(--fs-spacing-2) |\n| \\--fs-product-title-row-gap | var(--fs-spacing-3) |\n\n### Design tokens: Addendum\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | --------------------------------- |\n| \\--fs-product-title-addendum-color | var(--fs-color-text-light) |\n| \\--fs-product-title-addendum-size | var(--fs-text-size-1) |\n| \\--fs-product-title-addendum-line-height | 1.7 |\n\n---\n\n## Data attributes\n\nYou can target and override `ProductTitle` styles using the following data attributes:\n\n`data-fs-product-title`\n\n`data-fs-product-title-header`\n\n`data-fs-product-title-addendum`\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-product-title | | | | | | |\n| **title\\*** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A react component to be used as the product title, e.g. a \\`h1\\` |\n| **label** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A react component to be used as the product label, e.g. a \\`DiscountBadge\\` |\n| **refTag** | string | Label for reference. | Ref.: | | | | | | |\n| **refNumber** | string | A text to be used below the title and the label, such as the product's reference number. | | | | | | | |\n| **ratingValue** | number | The current value of the rating, a number from 0 to 5. | | | | | | | |\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/product-title.mdx)\n\n[ProductPrice« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-price)[QuantitySelectorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-quantity-selector)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23examples)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23design-tokens)\n\n[Design tokens: Addendum](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23design-tokens-addendum)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%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/product-title.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-product-title/docs/guides/faststore/molecules-product-title%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23examples)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23design-tokens)\n\n[Design tokens: Addendum](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23design-tokens-addendum)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title/docs/guides/faststore/molecules-product-title%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_31fd1057
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference marketplace protocol external marketplace orders API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Anti-fraud Provider APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders/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_c3234eba
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides 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/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/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/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/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/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/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/delivery-promise/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/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/delivery-promise/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/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/delivery-promise/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/delivery-promise/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/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/delivery-promise/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/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/delivery-promise/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/delivery-promise/docs/guides)\n\nLogistics\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise)\n\nDelivery Promise\n\nDelivery Promise helps your store show only products that can be delivered or picked up based on the customer’s location. It improves shopping experience, reduces cart abandonment, and increases product assortment visibility.\n\n> This feature is in beta, and we are actively working to improve it. If you have any questions, please contact [our Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n**Delivery Promise** is a VTEX solution that provides accurate and reliable delivery estimates for available products based on the customer's location. It ensures that customers only see products that are in stock and can be delivered to their address or picked up at a nearby location. Using this solution, your store can guarantee delivery for every product a customer sees.\n\nThe content is organized as follows:\n\n* [Available features](#available-features)\n* [Advantages](#advantages)\n* [Requirements and restrictions](#requirements-and-restrictions)\n* [Delivery Promise for Store Framework](#delivery-promise-for-store-framework)\n* [Delivery Promise for headless stores](#delivery-promise-for-headless-stores)\n* [Delivery Promise for FastStore](#delivery-promise-for-faststore)\n\n## Available features\n\nWhen the customer provides their address, an initial selection of products is made, displaying only products that can be delivered to that location or picked up at pickup points within a radius of up to 50 km from the provided address — a limit determined by Checkout.\n\n* Products available for the desired postal code.\n* Product delivery deadlines.\n* Products available in stores near the customer's location.\n* Faster shipping methods for order delivery.\n* [Pickup point](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) where the customer wants to pick up the order.\n\nAt this stage, **Delivery Promise** allows your store's customers to filter the products displayed during navigation by using these filters:\n\n| Filter | Description | Availability |\n| ---------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------- |\n| **Deliver to** | Products available for delivery to the specified address. | Store Framework and FastStore (only on PLPs and search results) |\n| **Pickup** | Products available for pickup at locations within up to 50 km of the specified address. | Store Framework and FastStore (only on PLPs and search results) |\n| **Pickup nearby** | Products available for pickup at locations within up to 10 km of the specified address. | Store Framework and FastStore (only on PLPs and search results) |\n| **Pickup at {{name}}** | Products available for pickup at a specific pickup point. | Store Framework and FastStore (only on PLPs and search results) |\n| **Global filters** | All products available in the store’s navigation. | FastStore |\n\n> The filters mentioned above are native components of Intelligent Search. If you want to develop custom components for your store, please contact your development team or an [implementation partner](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/4yPqZQyj0t675QpcG7H6yl%23implementation-partners).\n\n## Advantages\n\n**Delivery Promise** is suitable for all types of operations, as the solution provides many advantages for any business model. Learn about the store architecture requirements for participating in the current beta phase in the [Requirements and restrictions](#requirements-and-restrictions) section.\n\nFor [omnichannel](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/unified-commerce-strategies--3WGDRRhc3vf1MJb9zGncnv/2LGAiUnHES1enjHsfi8fI3) operations, the greater the coverage of the logistics network and the greater the number of sellers and [franchise accounts](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-franchise-account--kWQC6RkFSCUFGgY5gSjdl) associated with the operation, the greater the benefits. The table below shows the main advantages:\n\n| **Advantage** | **Details** |\n| -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Fewer abandoned carts | Customers often abandon an order after entering their location at the cart step when they find out that the products can't be shipped to their location or that the shipping time doesn't meet their expectations.With **Delivery Promise**, the availability and delivery feasibility of each product the customer sees on the product listing page are considered based on the customer's location. In addition, shipping information is displayed from the beginning of the customer's buying journey. |\n| Increased product assortment on the product listing page | Without **Delivery Promise**, the product assortment displayed on the product listing page may not reflect all available products from sellers due to limitations in features such as [seller regionalization](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configure-seller-regionalization--32t6wLpQCEnumoh8TjT5fw), [Comprehensive Seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/comprehensive-seller--5Qn4O2GpjUIzWTPpvLUfkI) and the [seller selection algorithm](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/white-label-sellers-selection--3MemNQ4pKkWCpMdzI27AHa).With **Delivery Promise**, the customer can view the complete product assortment of all sellers, provided that:Sellers are correctly configured..Products are available in stock..Products have a valid shipping method to the address entered by the customer. |\n| Improved shopping experience | **Delivery Promise** promotes a better shopping experience for the customer as a whole:It eliminates any frustration at checkout when they find it impossible to place an order.It allows customers to view more products.It allows customers to browse the storefront in a way that meets their needs, whether they prioritize the type of shipment or choose to place an order in a physical store. |\n| Promotion of physical store sales | **Delivery Promise** gives customers confidence in finding certain products in physical stores, which encourages them to go to the stores and increases sales opportunities. |\n\n## Requirements and restrictions\n\n**Delivery Promise** requires the customer's location from the beginning of the buying journey, ensuring that only products with valid shipping methods are displayed on the product listing page. To join the current phase of **Delivery Promise**, you must meet the following conditions:\n\n| Requirement | Description |\n| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Install Intelligent Search | Install the [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG) app in your VTEX account. This app provides advanced search capabilities for your store. |\n| Install Session Manager | Install the [Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-collecting-user-session-data) app in your VTEX account. This app enables your store to collect user session data. |\n| Build the storefront | Build your store's frontend using [Store Framework](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/67SCtUreXxKYWhZh8n0zvZ%23store-framework) or [FastStore](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/67SCtUreXxKYWhZh8n0zvZ%23faststore). |\n\n> Check the [Delivery Promise visual library](https://read.calvincode.net/reader?url=https://www.figma.com/community/file/1545494767147168145) with [use cases](https://read.calvincode.net/reader?url=https://www.figma.com/design/a9urb9GGi7BTQkX92hIPp8/Delivery-Promise-by-VTEX--Community-?node-id=8001-14743%26p=f%26t=6WFsbpkt0lln18z1-0), [behavior specifications](https://read.calvincode.net/reader?url=https://www.figma.com/design/a9urb9GGi7BTQkX92hIPp8/Delivery-Promise-by-VTEX--Community-?node-id=8002-48329%26p=f%26t=6WFsbpkt0lln18z1-0) and [components](https://read.calvincode.net/reader?url=https://www.figma.com/design/a9urb9GGi7BTQkX92hIPp8/Delivery-Promise-by-VTEX--Community-?node-id=8001-14732%26p=f%26t=6WFsbpkt0lln18z1-0) to better understand how to apply it to your store.\n\n## Delivery Promise for Store Framework\n\nWhen building your storefront with Store Framework, you can enable Delivery Promise components using the [Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components) and [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) apps.\n\nLearn how to configure these components in the [Setting up Delivery Promise components (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-delivery-promise-components) guide.\n\n## Delivery Promise for headless stores\n\nWhen using a headless approach in your store, you can use the [Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api) to enable Delivery Promise. To learn how to apply it to your store, read the [Delivery Promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores) guide.\n\n## Delivery Promise for FastStore\n\nWhen building your storefront with FastStore, you can enable Delivery Promise using hooks, filter options, and location priority. Learn how to apply it in the [Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise) guide.\n\nContributors\n\n2\n\n[](https://github.com/karenkrieger)\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/Logistics/delivery-promise.md)\n\n[Pickup point« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise//docs/guides/setting-up-white-label-seller-as-pickup-point)[Bulk Import Buyer Organizations SpreadsheetNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise//docs/guides/bulk-import-buyer-organizations-spreadsheet)\n\nSee also\n\nContributors\n\n2\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Available features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23available-features)\n\n[Advantages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23advantages)\n\n[Requirements and restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23requirements-and-restrictions)\n\n[Delivery Promise for Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-store-framework)\n\n[Delivery Promise for headless stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-headless-stores)\n\n[Delivery Promise for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-faststore)\n\nWas this helpful?\n\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/Logistics/delivery-promise.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Available features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23available-features)\n\n[Advantages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23advantages)\n\n[Requirements and restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23requirements-and-restrictions)\n\n[Delivery Promise for Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-store-framework)\n\n[Delivery Promise for headless stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-headless-stores)\n\n[Delivery Promise for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-faststore)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_cf6b35ba
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides login integration guide admin saml2 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide)\n\n[Admin (SAML 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2)\n\n[Webstore (OAuth 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-webstore-oauth2)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide)\n\n[Admin (SAML 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2)\n\n[Webstore (OAuth 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-webstore-oauth2)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides)\n\nIntegration Guides\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide)\n\n[Admin (SAML 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2)\n\nAdmin (SAML 2.0)\n\nUser management is a native feature of the VTEX platform. Store administrators can not only manage the users that can log in to the admin panel, but also specify which pages they can see and the operations they are allowed to perform using [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc). This granular control allows stores to adopt [best practices](https://read.calvincode.net/reader?url=https://developers.onelogin.com/saml/best-practices-and-faqs) in terms of security and compliance.\n\nHowever, there is often the need to enable or enforce the use of credentials from a central authentication system used by the organization. This guide provides the basic information you need to integrate such an authentication system to the Admin panel for a Single Sign-On (SSO) experience.\n\n> If you need to use an external identity provider to login to your Admin panel, it must adhere to the SAML 2.0 protocol. We do not currently support other authentication protocols for this scope.\n\n## SAML\n\nSecurity Assertion Markup Language (SAML) is a standard for exchanging authentication and authorization data between domains.\n\nSAML 2.0 is an XML-based protocol that enables web-based cross-domain Web Browser Single Sign-On (SSO). It uses secure, digitally signed tokens and encrypted messages to pass data between trusted parties.\n\nIt is an open standard, a product of the OASIS Security Services Technical Committee, and is supported by major vendors in the industry. Learn more about [SAML](https://read.calvincode.net/reader?url=https://github.com/jch/saml).\n\n## Authentication flow\n\n\n\n## SAML roles\n\nIn the context of SAML, you should be aware of the different roles performed by the entities that exchange information during authentication.\n\n### Identity Provider (IdP)\n\nAn **Identity Provider** (IdP) is a system that creates, maintains, and manages identity information for principals (users, services, or systems) and provides principal authentication to other Service Providers (applications) within a federation or distributed network.\n\nAn IdP is a trusted third party that can be relied upon when users and servers are establishing a dialog that must be authenticated. The IdP sends an attribute assertion containing trusted information about the user to the Service Provider. A user password is never sent to an SP.\n\n### Service Provider (SP)\n\nA **Service Provider** is an application server that communicates with an IdP to determine if a user has authenticated and obtain information about the user. The information obtained from the IdP may be used to make authorization decisions.\n\n> In the context of this guide, the external authentication system is the **Identity Provider** and the module for identifying users on the VTEX platform, VTEX ID, is the **Service Provider**.\n\n## SAML Assertions\n\nSAML 2.0 uses assertions (packages) to pass information between the SP and the IdP. These packages contain information about a user (subject) and are written using the XML markup language. Although the standard specification defines [three types of subject-related assertion statements](https://read.calvincode.net/reader?url=http://saml.xml.org/assertions), VTEX only supports the **Authentication Assertion** type. We recommend the reading of [this document](https://read.calvincode.net/reader?url=https://github.com/jch/saml) to get a better understanding of the SAML protocol.\n\n> An **Authentication Assertion** states that a user was authenticated by an external service at a particular time and is often used to enable web browser SSO.\n\n## Integration\n\nYou can implement a custom SAML login option for your Admin panel by providing some information about the communication between VTEX and your **identity provider**. To do that:\n\n1. Make sure that you have correctly [set up your identity provider](#identity-provider-configuration).\n2. Guarantee that you possess all the [required information](#required-information).\n3. Follow the [step by step setup](#setup).\n\n### Identity provider configuration\n\nIf required by the identity provider, you must use the appropriate service provider `metadata.xml` file to configure the identity provider. It is available for download in the following URL:\n\n`1\n\nhttps://vtexid.vtex.com.br/api/vtexid/pub/saml/{accountName}/sp/metadata \n\n`\n\nIf you do not use the file indicated above, configure your identity provider manually with the Assertion Consumer Service (ACS), **NameID** and **EntityDescriptor** present in the SP `metadata.xml`. URL:\n\n* **ACS**:\n\n`1\n\nhttps://vtexid.vtex.com.br/api/vtexid/pub/saml/{accountName}/idps/{accountName}-saml/sso \n\n`\n\n* **NameID**:\n\n`1\n\nurn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress \n\n`\n\n* **EntityDescriptor**:\n\n`1\n\nhttps://identity-broker.vtex.com/{accountName}/idps/{accountName}-saml \n\n`\n\n> The `entityID` of the **EntityDescriptor** is not a URL and must not be configured as one. It is an ID.\\\\n- The `{accountName}` is your business identification on the VTEX platform. It is the one you use inside the URL that gives access to your admin: `{accountName}.myvtex.com/admin`.\n\nThe identity provider must send the authenticated user's email in the **Name Identifier** (`saml:NameID`) variable. The response will be cryptographically signed with the certificate described in the Identity Provider's [Metadata](#metadata) file.\n\n### Required information\n\nIn the table below you can learn more about the information you need to provide when [setting up SAML](#setup).\n\n| **Information** | **Description** |\n| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Provider Name | Name displayed to unauthenticated users in the list of login options. |\n| SSO Service Endpoint | URL of your SAML Identity provider. Users will be redirected to this address. This URL must be HTTPS. |\n| Redirect URL | You can choose to redirect users to one of two URLs: https://{accountName}.myvtex.com/ or https://{accountName}.myvtex.com/admin. |\n| Allowed Email Hosts | List of hosts (the portion after the @ symbol in an email address) allowed for authentication. When a SAML Authentication Assertion is received by our platform, the email provided by the user is checked against the list of **Allowed Email Hosts**. Only emails with hosts listed here are allowed. |\n| Metadata | XML file that must be uploaded to the VTEX platform. It must describe your identity provider in a way that allows our servers to redirect users to it and securely identify assertions made by it. It usually contains information like the SSO and Logout URLs as well as the certificate used by the identity provider to sign the assertions. The authentication system your organization is using should be capable of generating this file for you. Learn more about [SAML 2.0 metadata](https://read.calvincode.net/reader?url=http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). This file must also contain the SSO Service Endpoint, described above. You can see an example file below. |\n\n#### Example metadata file\n\n`1\n\n<?xml version=\"1.0\"?> \n\n2\n\n<md:EntityDescriptor entityID=\"https://idp.example.org/SAML2\" validUntil=\"2013-03-22T23:00:00Z\" \n\n3\n\n xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" \n\n4\n\n xmlns:saml=\"urn:oasis:names:tc:SAML:2.0:assertion\" \n\n5\n\n xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"> \n\n6\n\n <md:IDPSSODescriptor protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\" WantAuthnRequestsSigned=\"false\"> \n\n7\n\n <md:KeyDescriptor use=\"signing\"> \n\n8\n\n <ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"> \n\n9\n\n <ds:X509Data> \n\n10\n\n <ds:X509Certificate>...</ds:X509Certificate> \n\n11\n\n </ds:X509Data> \n\n12\n\n </ds:KeyInfo> \n\n13\n\n </md:KeyDescriptor> \n\n14\n\n <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat> \n\n15\n\n <md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://idp.example.org/SAML2/SSO/Redirect\"/> \n\n16\n\n <md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://idp.example.org/SAML2/SSO/POST\"/> \n\n17\n\n </md:IDPSSODescriptor> \n\n18\n\n <md:Organization> \n\n19\n\n <md:OrganizationName xml:lang=\"en\">Some Non-profit Organization of New York</md:OrganizationName> \n\n20\n\n <md:OrganizationDisplayName xml:lang=\"en\">Some Non-profit Organization</md:OrganizationDisplayName> \n\n21\n\n <md:OrganizationURL xml:lang=\"en\">https://www.example.org/</md:OrganizationURL> \n\n22\n\n </md:Organization> \n\n23\n\n <md:ContactPerson contactType=\"technical\"> \n\n24\n\n <md:SurName>SAML Technical Support</md:SurName> \n\n25\n\n <md:EmailAddress>mailto:saml-support@example.org</md:EmailAddress> \n\n26\n\n </md:ContactPerson> \n\n27\n\n</md:EntityDescriptor> \n\n`\n\n### Setup\n\nOnce you have [setup your identity provider](#identity-provider-configuration) and have all the [required information](#required-information), follow these steps to set up SAML login:\n\n1. Go to the **Admin panel** \\> **Account settings** \\> **Authentication**.\n2. Click the **Admin** tab. \n\n3. Click `Set up` in the **My SAML** section.\n4. Fill in the [required information](#required-information) as described above. \n\n5. Upload your metadata XML according to the information provided in [required information](#required-information). \n\n6. You have the option of setting the **Send AuthRequest** toggle. Turning it on means that the attributes `RelayState` and `SAMLRequest` will be sent on the URL when authenticating on the identity provider.\n7. Click `Save`.\n\nWith this, your SAML configuration is set up.\n\n### Edit existing SAML configuration\n\nOnce you created your SAML configuration, you may edit it by going through the same steps described above, in [Setup](#setup).\n\n## Certificate renewals\n\nWhen the certificate used by your **Identity Provider** to sign the assertions is about to expire, it's important to update the `metadata.xml` file in VTEX to allow for a seamless transition between the old and the new certificate.\n\nThis is done by including two `<md:KeyDescriptor use=\"signing\">` entries in your exported file, as seen in the example below, where the `{OLD CERTIFICATE}` and `{NEW CERTIFICATE}` placeholders should be replaced by valid **X.509** certificates.\n\n`1\n\n<?xml version=\"1.0\"?> \n\n2\n\n<md:EntityDescriptor entityID=\"https://idp.example.org/SAML2\" validUntil=\"2013-03-22T23:00:00Z\" \n\n3\n\n xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" \n\n4\n\n xmlns:saml=\"urn:oasis:names:tc:SAML:2.0:assertion\" \n\n5\n\n xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"> \n\n6\n\n <md:IDPSSODescriptor protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\" WantAuthnRequestsSigned=\"false\"> \n\n7\n\n <md:KeyDescriptor use=\"signing\"> \n\n8\n\n <ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"> \n\n9\n\n <ds:X509Data> \n\n10\n\n <ds:X509Certificate>{OLD CERTIFICATE}</ds:X509Certificate> \n\n11\n\n </ds:X509Data> \n\n12\n\n </ds:KeyInfo> \n\n13\n\n </md:KeyDescriptor> \n\n14\n\n <md:KeyDescriptor use=\"signing\"> \n\n15\n\n <ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"> \n\n16\n\n <ds:X509Data> \n\n17\n\n <ds:X509Certificate>{NEW CERTIFICATE}</ds:X509Certificate> \n\n18\n\n </ds:X509Data> \n\n19\n\n </ds:KeyInfo> \n\n20\n\n </md:KeyDescriptor> \n\n21\n\n <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat> \n\n22\n\n <md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://idp.example.org/SAML2/SSO/Redirect\"/> \n\n23\n\n <md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://idp.example.org/SAML2/SSO/POST\"/> \n\n24\n\n </md:IDPSSODescriptor> \n\n25\n\n <md:Organization> \n\n26\n\n <md:OrganizationName xml:lang=\"en\">Some Non-profit Organization of New York</md:OrganizationName> \n\n27\n\n <md:OrganizationDisplayName xml:lang=\"en\">Some Non-profit Organization</md:OrganizationDisplayName> \n\n28\n\n <md:OrganizationURL xml:lang=\"en\">https://www.example.org/</md:OrganizationURL> \n\n29\n\n </md:Organization> \n\n30\n\n <md:ContactPerson contactType=\"technical\"> \n\n31\n\n <md:SurName>SAML Technical Support</md:SurName> \n\n32\n\n <md:EmailAddress>mailto:saml-support@example.org</md:EmailAddress> \n\n33\n\n </md:ContactPerson> \n\n34\n\n</md:EntityDescriptor> \n\n`\n\nAs the SP, VTEX ID must know of the new certificate or it will not be able to validate the signatures. And since the SP is unable to check at what stage of renewal the IdP is, it always checks if the signature validates for each of the listed certificates.\n\n> We recommend checking if your IdP allows the configuration of a primary and secondary certificate to simplify the export process.\n\nOnce the old certificate expires, you may remove it from the `metadata.xml` file and re-upload it if you wish to avoid unnecessary requests in the **Send Valid Credentials** step of the [SAML authentication flow](#authentication-flow).\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/login-integration-guide/login-integration-guide-admin-saml2.md)\n\n[Login (SSO)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2//docs/guides/login-integration-guide)[Webstore (OAuth 2.0)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2//docs/guides/login-integration-guide-webstore-oauth2)\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[SAML](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml)\n\n[Authentication flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23authentication-flow)\n\n[SAML roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml-roles)\n\n[Identity Provider (IdP)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23identity-provider-idp)[Service Provider (SP)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23service-provider-sp)\n\n[SAML Assertions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml-assertions)\n\n[Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23integration)\n\n[Identity provider configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23identity-provider-configuration)[Required information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23required-information)[Setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23setup)[Edit existing SAML configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23edit-existing-saml-configuration)\n\n[Certificate renewals](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23certificate-renewals)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/login-integration-guide/login-integration-guide-admin-saml2.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[SAML](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml)\n\n[Authentication flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23authentication-flow)\n\n[SAML roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml-roles)\n\n[Identity Provider (IdP)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23identity-provider-idp)[Service Provider (SP)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23service-provider-sp)\n\n[SAML Assertions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml-assertions)\n\n[Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23integration)\n\n[Identity provider configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23identity-provider-configuration)[Required information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23required-information)[Setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23setup)[Edit existing SAML configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23edit-existing-saml-configuration)\n\n[Certificate renewals](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23certificate-renewals)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_cdff2331
|
[
{
"role": "system",
"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 powerreviews 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.powerreviews/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/api-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.powerreviews/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.powerreviews/docs/storefront-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.powerreviews/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.powerreviews/docs/troubleshooting)\n\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.powerreviews/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/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.powerreviews/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.powerreviews/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/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.powerreviews/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.powerreviews/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.powerreviews/docs/vtex-io-apps)\n\nPowerReviews\n\nOfficial extension\n\nVersion: 2.4.1\n\nLatest version: 2.4.1\n\n[](#contributors-)\n\nThe PowerReviews app provides a way to bring your PowerReviews content into your VTEX store. The app also implements the PowerReviews Checkout Beacon during checkout, sending customer purchase data to the PowerReviews platform.\n\n## Configuration\n\nBefore you can start using the app, you will need an existing [PowerReviews](https://read.calvincode.net/reader?url=https://www.powerreviews.com/) account and API key.\n\n### Step 1 - Defining the app settings\n\nIn your VTEX account's admin, perform the following actions:\n\n1. Access the **Apps** section and then **My Apps**.\n2. Select the **PowerReviews** app box.\n3. Complete the following required fields in the Settings section:\n* `App Key` \\- The API Key provided by PowerReviews.\n* `Merchant ID` \\- Your unique PowerReviews merchant ID.\n* `Merchant Group ID` \\- Your PowerReviews merchant group ID.\n* `Client ID` \\- Your PowerReviews Client ID\n* `Client Secret` \\- Your PowerReviews Client Secret\n* `Send Email After Invoicing` \\- Instead of sending email after checkout, we can send email after an order has been invoiced. Enabling this disables purchase pixel's ability to track checkout\n* `API Unique Id` \\- The product field used as the identifier (or pageId) on PowerReviews.\n\nOptionally, the `Use Legacy Review Display Component` checkbox allows you to use the PowerReviews Review Display component instead of the VTEX Reviews component.\n\nIf needed, provide a URL path to a CSS stylesheet to override the styles of the PowerReviews Write-a-Review, Questions & Answers, or Review Display components.\n\n### Step 2 - Update your store theme\n\n1. Add the `powerreviews` app as a `peerDependency` in your theme's `manifest.json` file:\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n+ \"vtex.powerreviews\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. If not already present, add the following to your theme's `dependencies`:\n\n`1\n\n \"vtex.product-review-interfaces\": \"1.x\", \n\n2\n\n \"vtex.product-summary-context\": \"0.x\", \n\n3\n\n \"vtex.product-context\": \"0.x\", \n\n4\n\n \"vtex.store-header\": \"2.x\", \n\n5\n\n \"vtex.pixel-interfaces\": \"1.x\", \n\n6\n\n \"vtex.store-image\": \"0.x\", \n\n`\n\n### Step 3 - Defining the app's blocks\n\nThe PowerReviews app integrates with the following store framework blocks.\n\n| Block name | Description |\n| ----------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| product-reviews | Display a paginated list of reviews for the product being viewed. This must be placed on the store.product page. |\n| product-rating-summary | Display the average rating for the product being viewed. This must be placed on the store.product page. |\n| product-rating-inline | Display the average rating for the product being viewed, intended for use on the product shelf. |\n| product-review-form | Display the PowerReviews Write-a-Review form component. This must be placed on the product-review-form page. |\n| product-questions-and-answers | Display the PowerReviews Questions & Answers component for the product being viewed. |\n\nAn example of the blocks above in use:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"product-rating-summary\", \n\n4\n\n \"product-reviews\", \n\n5\n\n \"product-questions-and-answers\" \n\n6\n\n ] \n\n7\n\n } \n\n`\n\n`1\n\n \"store.product-review-form\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"product-review-form\" \n\n4\n\n ] \n\n5\n\n } \n\n`\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/apps/vtex.powerreviews%23configuration)\n\n[Step 1 - Defining the app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/apps/vtex.powerreviews%23step-1-defining-the-app-settings)[Step 2 - Update your store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/apps/vtex.powerreviews%23step-2-update-your-store-theme)[Step 3 - Defining the app's blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/apps/vtex.powerreviews%23step-3-defining-the-apps-blocks)\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_22a34b3b
|
[
{
"role": "system",
"content": "You are a VTEX 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 table in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-table/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-table/docs/api-reference)\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-table/docs/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-table/docs/storefront-development)\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-table/docs/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-table/docs/troubleshooting)\n\n[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-table/updates/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-table/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-table/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/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-table/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/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-table/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/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-table/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-table/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-table/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-table/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/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-table/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-table/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/updates/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-table/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-table/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/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-table/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/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-table/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/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-table/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-table/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-table/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-table/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/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-table/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-table/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-table/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-overview)\n\nTable\n\nDisplays information in a friendly way, allowing users to scan for details quickly.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Table)\n\nTables display information in a friendly way, allowing users to scan for details quickly.The Table component is a compound of the following:\n\n* `Table` \\- renders a `<div>` as wrapper with a `<table>` tag inside it.\n* `TableBody` \\- renders a `<tbody>` tag.\n* `TableHead` \\- renders a `<thead>` tag.\n* `TableRow` \\- renders a `<tr>` tag.\n* `TableFooter` \\- renders a `<tfoot>` tag.\n* `TableCell` \\- renders a `<th>` or `<td>` tag depending on the value of the `variant` prop.\n\nExample\n\nCode\n\n| Colored + Icon | Values |\n| -------------- | ------------ |\n| Width | 1.5m |\n| Height | 1.5m |\n| Dimensions | 7 x 3 x 9 in |\n\n| Bordered + Icon | Total |\n| --------------- | ----- |\n| 1x | $200 |\n| 2x | $200 |\n| 3x | $204 |\n\n| Colored | Total |\n| ------- | ----- |\n| 1x | $200 |\n| 2x | $200 |\n| 3x | $204 |\n\n| Bordered | Total |\n| -------- | ----- |\n| 1x | $200 |\n| 2x | $200 |\n| 3x | $204 |\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Table } 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/Table/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### Colored\n\nExample\n\nCode\n\n| Colored | Total |\n| ------- | ----- |\n| 1x | $200 |\n| 2x | $200 |\n| 3x | $204 |\n\n### With footer\n\nExample\n\nCode\n\n| 1x | $200 |\n| ----- | ---- |\n| 2x | $200 |\n| 3x | $204 |\n| Total | $604 |\n\n### Bordered\n\nExample\n\nCode\n\n| Bordered | Total |\n| -------- | ----- |\n| 1x | $200 |\n| 2x | $200 |\n| 3x | $204 |\n\n### Horizontal Scroll\n\nExample\n\nCode\n\n| Installments | Monthly Payment | Min Items | Max Items | Subtotal | Total |\n| ------------ | --------------- | --------- | --------- | -------- | ----- |\n| 1x | $200 | 1 | 4 | $200 | $200 |\n| 2x | $100 | 10 | 20 | $100 | $200 |\n| 3x | $68 | 1 | 10 | $68 | $204 |\n\n---\n\n## Design tokens\n\n### Head\n\n| Local token | Default value/Global token linked |\n| -------------------------- | --------------------------------- |\n| \\--fs-table-head-weight | var(--fs-text-weight-bold) |\n| \\--fs-table-head-bkg-color | none |\n| \\--fs-table-head-padding-y | var(--fs-spacing-2) |\n\n### Cell\n\n| Local token | Default value/Global token linked |\n| -------------------------- | --------------------------------- |\n| \\--fs-table-cell-padding-x | var(--fs-spacing-3) |\n| \\--fs-table-cell-padding-y | var(--fs-spacing-1) |\n\n### Design tokens: Footer\n\n| Local token | Default value/Global token linked |\n| ---------------------------- | --------------------------------- |\n| \\--fs-table-footer-weight | var(--fs-table-head-weight) |\n| \\--fs-table-footer-bkg-color | none |\n\n### Design tokens: Colored\n\n| Local token | Default value/Global token linked |\n| --------------------------------- | --------------------------------- |\n| \\--fs-table-colored-bkg-color | var(--fs-color-neutral-1) |\n| \\--fs-table-colored-border-radius | var(--fs-border-radius) |\n\n### Design tokens: Bordered\n\n| Local token | Default value/Global token linked |\n| ----------------------------------- | --------------------------------- |\n| \\--fs-table-bordered-border-width | var(--fs-border-width) |\n| \\- --fs-table-bordered-border-color | var(--fs-border-color-light) |\n\n---\n\n## Data attributes\n\nYou can target and override `Table` styles using the following data attributes:\n\n`data-fs-table`\n\n`data-fs-table-content`\n\n`data-fs-table-head`\n\n`data-fs-table-row`\n\n`data-fs-table-footer`\n\n`data-fs-table-body`\n\n`data-fs-table-cell=\"head | data\"`\n\n`data-fs-table-variant=\"colored | bordered\"`\n\n---\n\n## Props\n\nAll table-related components support all attributes also supported by their respective HTML tags. Besides those attributes, the following props are also supported:\n\n### Table\n\n| Name | Type | Description | Default |\n| ------------------- | -------------------------- | -------------------------------------------------------------------------------------- | -------- |\n| **variant** | \"colored\" \\| \"bordered\" | Defines what style this component should use. | colored |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-table |\n| **onResize** | ReactEventHandler<unknown> | Call a function when the component is resized. | |\n| **onResizeCapture** | ReactEventHandler<unknown> | A version of onResize that fires in the capture phase. | |\n| **nonce** | string | A randomly generated string that is only used once. | |\n\n### TableBody\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-table-body |\n\n### TableHead\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-table-head |\n\n### TableRow\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-table-row |\n\n### TableFooter\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-table-footer |\n\n### TableCell\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-table-cell | |\n| **variant** | \"data\" \\| \"header\" | Specify if this component should be rendered as a header (\\`<th>\\`) or as a data cell (\\`<td>\\`). | data | |\n| **scope** | \"col\" \\| \"row\" | \"rowgroup\" | \"colgroup\" | Defines the cells that the header element (\\`<th>\\`) relates to. @see scope https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th#attr-scope |\n| **align** | \"left\" \\| \"center\" | \"right\" | Defines how this component should be aligned. | |\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/table.mdx)\n\n[SKUSelector« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-sku-selector)[TagNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-tag)\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-table/docs/guides/faststore/molecules-table%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23examples)\n\n[Colored](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23colored)[With footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23with-footer)[Bordered](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23bordered)[Horizontal Scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23horizontal-scroll)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23design-tokens)\n\n[Head](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23head)[Cell](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23cell)[Design tokens: Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23design-tokens-footer)[Design tokens: Colored](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23design-tokens-colored)[Design tokens: Bordered](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23design-tokens-bordered)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23props)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23table)[TableBody](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23tablebody)[TableHead](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23tablehead)[TableRow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23tablerow)[TableFooter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23tablefooter)[TableCell](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23tablecell)\n\nWas this helpful?\n\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/table.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-table/docs/guides/faststore/molecules-table%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23examples)\n\n[Colored](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23colored)[With footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23with-footer)[Bordered](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23bordered)[Horizontal Scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23horizontal-scroll)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23design-tokens)\n\n[Head](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23head)[Cell](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23cell)[Design tokens: Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23design-tokens-footer)[Design tokens: Colored](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23design-tokens-colored)[Design tokens: Bordered](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23design-tokens-bordered)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23props)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23table)[TableBody](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23tablebody)[TableHead](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23tablehead)[TableRow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23tablerow)[TableFooter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23tablefooter)[TableCell](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-table/docs/guides/faststore/molecules-table%23tablecell)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_489318d3
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation customizing your 404 page in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-routing)\n\n[Adding custom headers to your Store Framework store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store)\n\n[Best practices for associating a custom page with a content type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)\n\n[Customizing your 404 page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-customizing-your-404-page)\n\n[Enabling 404 pages for invalid single-segment paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)\n\n[Managing URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-managing-url-redirects)\n\n[Using several service workers in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-routing)\n\n[Adding custom headers to your Store Framework store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store)\n\n[Best practices for associating a custom page with a content type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)\n\n[Customizing your 404 page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-customizing-your-404-page)\n\n[Enabling 404 pages for invalid single-segment paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)\n\n[Managing URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-managing-url-redirects)\n\n[Using several service workers in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/store-framework-routing)\n\n[Customizing your 404 page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-customizing-your-404-page)\n\nCustomizing your 404 page\n\nLearn how to customize your store's 404 error page using Store Framework.\n\nThis guide provides instructions for customizing your store's 404 pages using the VTEX IO Store Framework. With flexible blocks and configurations, you can create a custom error page that aligns with your brand and helps users seamlessly navigate back to key areas of your site.\n\n## Instructions\n\nTo customize 404 pages, follow the steps below:\n\n1. Open the terminal and [switch to a development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/).\n2. Open your [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) using your preferred code editor.\n3. In the product or search template (`store.product` or `store.search`), add and configure the `store.not-found#product` or `store.not-found#search` block, respectively. See below an example of a `store.not-found#product` configuration for a product template: \n`1 \n\"store.not-found#product\": { \n2 \n \"blocks\": [\"rich-text#not-found\"] \n3 \n}, \n4 \n\"rich-text#not-found\": { \n5 \n \"props\": { \n6 \n \"textAlignment\": \"CENTER\", \n7 \n \"textPosition\": \"CENTER\", \n8 \n \"text\": \"**PAGE NOT FOUND**\", \n9 \n \"font\": \"t-heading-1\" \n10 \n } \n11 \n} \n`\n\n> The `store.not-found` blocks will only be rendered when the server returns a 404 error. The child block will be displayed to users in such cases.\n\n1. Save your changes and run `vtex link` in your terminal to preview the updated 404 page:\n\n\n\n1. Once you're satisfied with the changes, [publish your new theme version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/).\n\nContributors\n\n1\n\n[](https://github.com/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/pages/vtex-io-documentation-customizing-your-404-page.md)\n\n[Best practices for associating a custom page with a content type« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page//docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)[Enabling 404 pages for invalid single-segment pathsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page//docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)\n\nSee also\n\n[Enabling 404 pages for invalid single Segment pathsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-404-page/docs/guides/vtex-io-documentation-customizing-your-404-page%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/pages/vtex-io-documentation-customizing-your-404-page.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-customizing-your-404-page/docs/guides/vtex-io-documentation-customizing-your-404-page%23instructions)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_ac3bd222
|
[
{
"role": "system",
"content": "You are a VTEX 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 breadcrumb in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-breadcrumb/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-breadcrumb/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/updates/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-breadcrumb/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-breadcrumb/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/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-breadcrumb/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/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-breadcrumb/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/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-breadcrumb/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-breadcrumb/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-breadcrumb/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-breadcrumb/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/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-breadcrumb/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-breadcrumb/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/updates/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-breadcrumb/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-breadcrumb/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/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-breadcrumb/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/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-breadcrumb/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/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-breadcrumb/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-breadcrumb/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-breadcrumb/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-breadcrumb/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/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-breadcrumb/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-breadcrumb/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-breadcrumb/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-overview)\n\nBreadcrumb\n\nIndicates the user's location in a website hierarchy.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Breadcrumb)\n\nExample\n\nCode\n\n1. [Echo Dot Smart Speaker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/echo-dot-smart-speaker-99988214/p)\n2. Oculus VR Headset\n\n1. [Technology](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/technology/)\n2. [Echo Dot Smart Speaker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/echo-dot-smart-speaker-99988214/p)\n3. Oculus VR Headset\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Breadcrumb } 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/Breadcrumb/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-breadcrumb-margin-left | var(--fs-spacing-0) |\n\n## List Item\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------- | --------------------------------- |\n| \\--fs-breadcrumb-list-item-padding | var(--fs-spacing-0) |\n| \\--fs-breadcrumb-list-item-last-text-color | var(--fs-color-text-light) |\n| \\--fs-breadcrumb-list-item-max-width-mobile | 30% |\n\n## Link\n\n| Local token | Default value/Global token linked |\n| ----------------------------------- | --------------------------------- |\n| \\--fs-breadcrumb-link-color-visited | var(--fs-color-link) |\n\n## Link Home\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------ | --------------------------------- |\n| \\--fs-breadcrumb-link-home-padding | var(--fs-spacing-1) |\n| \\--fs-breadcrumb-link-home-border-radius | var(--fs-border-radius-circle) |\n| \\--fs-breadcrumb-link-home-hover-bkg-color | var(--fs-color-primary-bkg-light) |\n| \\--fs-breadcrumb-link-home-color | var(--fs-color-text) |\n\n## Divider\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------ | --------------------------------- |\n| \\--fs-breadcrumb-divider-height | var(--fs-spacing-3) |\n| \\--fs-breadcrumb-divider-margin | var(--fs-spacing-1) |\n| \\--fs-breadcrumb-divider-border-left-width | var(--fs-border-width) |\n| \\--fs-breadcrumb-divider-border-left-color | var(--fs-border-color-light) |\n\n## Dropdown Button\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------------------- | --------------------------------- |\n| \\--fs-breadcrumb-dropdown-button-margin-left | var(--fs-breadcrumb-margin-left) |\n| \\--fs-breadcrumb-dropdown-button-color | var(--fs-color-link) |\n| \\--fs-breadcrumb-dropdown-button-border-radius | var(--fs-spacing-0) |\n| \\--fs-breadcrumb-dropdown-button-transition-property | var(--fs-transition-property) |\n| \\--fs-breadcrumb-dropdown-button-transition-timing | var(--fs-transition-timing) |\n| \\--fs-breadcrumb-dropdown-button-transition-function | var(--fs-transition-function) |\n\n---\n\n## Data attributes\n\nYou can target and override `Breadcrumb` styles using the following data attributes:\n\n`data-fs-breadcrumb`\n\n`data-fs-breadcrumb-list`\n\n`data-fs-breadcrumb-list-item`\n\n`data-fs-breadcrumb-link`\n\n`data-fs-breadcrumb-link-home`\n\n`data-fs-breadcrumb-divider`\n\n`data-fs-breadcrumb-dropdown-button`\n\n`data-fs-breadcrumb-dropdown-menu`\n\n`data-fs-breadcrumb-dropdown-link`\n\n`data-fs-breadcrumb-is-desktop=\"true | false\"`\n\n---\n\n## Props\n\n| Name | Type | Description | Default | | | | | | |\n| ---------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -- | ------------------------ | --------------------------- | ------------------- | ----------- | ------------------------------------------------------ |\n| **breadcrumbList\\*** | ItemElement\\[\\] | Array of ItemElement that represents each breadcrumb item. | | | | | | | |\n| **homeLink** | ReactElement<any, string \\| JSXElementConstructor<any>> | Link go to home. | | | | | | | |\n| **dropdownButtonIcon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Icon for dropdown button. |\n| **collapsedItemsIcon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Icon for collapsed items. |\n| **renderLink** | (renderLinkProps: RenderLinkProps) => ReactElement<any, string \\| JSXElementConstructor<any>> | Function to render a item as breadcrumb link. @param renderLinkProps Properties for each item to be rendered. @returns Link to be rendered. | | | | | | | |\n| **divider** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A ReactNode that will be rendered as the Divider icon. |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | | | | | | | |\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/breadcrumb.mdx)\n\n[Alert« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-alert)[BuyButtonNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-buy-button)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23design-tokens)\n\n[List Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23list-item)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23link)\n\n[Link Home](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23link-home)\n\n[Divider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23divider)\n\n[Dropdown Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23dropdown-button)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%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/breadcrumb.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-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23design-tokens)\n\n[List Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23list-item)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23link)\n\n[Link Home](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23link-home)\n\n[Divider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23divider)\n\n[Dropdown Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23dropdown-button)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb/docs/guides/faststore/molecules-breadcrumb%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_1d09a0ad
|
[
{
"role": "system",
"content": "You are a VTEX 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 service in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-service/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-service/docs/api-reference)\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-service/docs/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-service/docs/storefront-development)\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-service/docs/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-service/docs/troubleshooting)\n\n[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-service/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-service/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-service/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-service/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-service/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-service/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-service/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-service/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-service/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/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/vtex-io-documentation-service/docs/guides/developing-services-on-vtex-io)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/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-service/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-service/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-service/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-service/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-service/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-service/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-service/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-service/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/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-service/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-service/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-service/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-service/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/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-service/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-service/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-service/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-service/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-service/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-service/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-service/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-service/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/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/vtex-io-documentation-service/docs/guides/developing-services-on-vtex-io)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/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-service/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-service/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-service/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-service/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-service/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-service/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-service/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-service/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/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-service/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-service/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-service/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-service/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service)\n\nService\n\nIn the VTEX IO ecosystem, services play a crucial role by allowing you to run .NET and Node.js code directly on VTEX servers. Services enable VTEX IO apps to export HTTP routes, GraphQL resolvers, and event handlers to the server.\n\n## Developing services\n\nTo create and export services, you need to specify the `node` or `dotnet` [builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) in your app's [manifest.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest) file. Additionally, GraphQL services can be exported using the `graphql` builder.\n\n> For a practical example, refer to our service example apps: [Node.js](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example), [.NET](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example-dotnet), and [GraphQL](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/graphql-example).\n\nFor more information, check the [Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-service-course-lang-en) course in the VTEX Learning Center.\n\n## Configuring services\n\nThe configuration of your service depends on the selected builder (`node` or `dotnet`). You will find the `service.json` file in the `/node` or `/dotnet` folder of your app. This configuration file is responsible for defining essential parameters, including timeout, memory allocation, routes, event handlers, and replicas.\n\nHere's an example of a `service.json` file:\n\nservice.json\n\n`1\n\n{ \n\n2\n\n \"memory\": 256, \n\n3\n\n \"ttl\": 10, \n\n4\n\n \"timeout\": 2, \n\n5\n\n \"minReplicas\": 2, \n\n6\n\n \"maxReplicas\": 4, \n\n7\n\n \"routes\": { \n\n8\n\n \"status\": { \n\n9\n\n \"path\": \"/_v/status/:code\", \n\n10\n\n \"public\": true \n\n11\n\n } \n\n12\n\n } \n\n13\n\n} \n\n`\n\n## Service configuration parameters\n\nLet's delve into the parameters you can set within the `service.json` file:\n\n| Name | Type | Description |\n| -------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| memory | number | Defines the memory size (in MB) that should be allocated to the service. Default: 128, maximum: 1024. |\n| minReplicas | number | Defines the minimum number of replicas available when the service is running. Minimum: 2 for installed apps and 1 for linked apps. |\n| maxReplicas | number | Defines the maximum number of replicas available. Minimum: 5, maximum: 60. |\n| timeout | number | Sets the timeout (in seconds) for aborting a connection if a request takes too long. This parameter affects only incoming requests to the app. It does not affect outgoing requests that the app makes to other clients. Default: 10, minimum: 1, maximum: 60. |\n| ttl | number | Defines the time-to-live (in minutes) for how long the platform will keep each instance of the service running without receiving new requests. Default: 10, minimum: 10, maximum: 60\\. The requested value is only honored for the most recent stable version of the app. Older versions, versions that have not been deployed, linked apps, or beta versions will have the value overridden to 10. |\n| workers | number | Specifies the number of workers to spawn for the service on production. Minimum: 1, maximum: 4. |\n| rateLimitPerReplica | object | This object contains global parameters whose values define specific throttling limits for requests and events. The values of this object are overridden by the values set for a specific route or event. |\n| ↳perMinute | number | Defines the global maximum number of requests and event triggers allowed per minute per replica. This value is overridden by the value set for a specific route or event. |\n| ↳concurrent | number | Defines the global maximum number of requests and event triggers a replica will handle simultaneously for that application. This value is overridden by the value set for a specific route or event. |\n| events | object of objects | Each object inside this parameter represents one event. Maps an event handler to an object that describes the sender or topics. This parameter must be used both by the sender and the receivers of the event. |\n| ↳topics | array of strings | Identifiers of the event. Previously known as keys, which is now deprecated. |\n| ↳sender | string | Name of the app that sends the event. |\n| ↳settingsType | string | Possible values: pure, workspace, or userAndWorkspace. If workspace or userAndWorkspace, the app loads the settings of the apps it depends on. |\n| ↳rateLimitPerReplica | object | This object contains parameters whose values define specific throttling limits for the event. The values of this object override the global rateLimitPerReplica values. |\n| ↳↳perMinute | number | Defines the maximum amount of times this event is allowed to trigger per minute per replica. This value overrides the global rateLimitPerReplica.perMinute value. |\n| ↳↳concurrent | number | Defines the maximum amount of times a replica will handle triggers of this event simultaneously. This value overrides the global rateLimitPerReplica.concurrent value. |\n| routes | object of objects | Each object inside this represents one route. Maps route handlers to objects containing information about the route. |\n| ↳path | string | Path of the route. Check [Service path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns) for details about path construction. |\n| ↳public | boolean | Defines if the route is public or private. If true, the route will be available at {account}.myvtex.com and {account}.vtexcommercestable.com.br. If false, the route will be at app.io.vtex.com/{vendor}.{appName}/v{majorVersion}/{account}/{workspace} and will require a VtexidClientAutCookie for [authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens). Using appKey and appToken for authentication will not work. |\n| ↳access | string | Possible values: public, authenticated, or authorized. |\n| ↳policies | array of objects | Defines the actions allowed or denied with the route by whom. More details on [Resource-based Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies%23resource-based-policies). |\n| ↳rateLimitPerReplica | object | This object contains parameters whose values define specific throttling limits for the route. The values of this object override the global rateLimitPerReplica values. |\n| ↳↳perMinute | number | Defines the maximum number of requests allowed per minute per replica for this route. This value overrides the global rateLimitPerReplica.perMinute value. |\n| ↳↳concurrent | number | Defines the maximum number of requests a replica will handle for this route. This value overrides the global rateLimitPerReplica.concurrent value. |\n\nNote that most of these fields are optional, and default values provided by the platform are often sufficient.\n\n## Best practices\n\nTo help configuring your service, we describe some best practices below about many of the parameters available. This should help achieve good performance and avoid failures with your application.\n\n### Memory allocation\n\nApp developers have to evaluate the `memory` usage of the app to choose a proper value for the memory parameter. Consider factors such as the complexity of your application, and the size of the data structures instanced in the implementation. Adequate memory allocation helps prevent failures and performance issues.\n\n### Timeout settings\n\nSetting an appropriate `timeout` value prevents requests from timing out prematurely or causing resource exhaustion. Ideally, it is expected that applications have low response times most of the time, in the range of milliseconds, and do not fail to process the requests.\n\nIn scenarios where an application has a low timeout setting and takes too long to respond, the platform will respond to the request with a timeout response and the data from the app will not be delivered to the client when the request could be processed. On the other hand, in scenarios where the timeout setting is high and the application usually does not take long to respond, if a problem occurs with the processing of the request, the platform will take too long to respond with a timeout and inform the client that a problem has occurred.\n\nBalancing between a low or high timeout setting depends on the time that is expected to deliver a response and how fast the requester requires the response to perform its work.\n\nTesting response times to decide a proper timeout setting can be done in various ways including, but not limited to, different connection conditions (mobile vs. tethered, instabilities, etc.), requests from different locations, different workloads and settings (memory, replicas, etc.), and measuring percentiles of the slowest response times.\n\n### Replica management\n\nVTEX has an autoscaling feature for the IO infrastructure, which dynamically controls the number of instances of each app obeying certain parameters. We call replicas the number of instances of an app running in our infrastructure. The minimum and maximum replicas an app can have are determined by the parameters `minReplicas` and `maxReplicas`, respectively. The current replicas increase and decrease automatically according to how much the app is requested in the platform, considering all the accounts where the app is installed.\n\nThe values of `minReplicas` and `maxReplicas` should be defined considering the expected demand for the app. If you have observability on the accounts where the app is installed, some metrics can help define the parameters, e.g., the number of accesses or purchases and how they fluctuate.\n\n### Route configuration\n\nThis configuration defines the paths of the endpoints that the app will expose, among other properties like if it is public or private, and the permissions through policies. For more details about the path construction, read [Service path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns). For more information about permissions of the endpoints, read [Resource-based Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies%23resource-based-policies).\n\n### TTL management\n\nTime-to-live (TTL) is the time that a service instance will keep running in the platform without receiving new requests before it is shut down. By having a TTL, we can minimize resource wastage from service instances.\n\nWhen new requests are made and there are no instances available to respond, the platform has to start new instances to process and respond to the requests, a process that we call cold start. A cold start is slow, so the first request a new instance responds to takes longer than usual, and the following requests are processed as usual.\n\nDepending on the service usage, a small TTL value can lead to cold starts happening more frequently, which causes slower response times. We recommend increasing the TTL above the default value only if you frequently notice slow response times that can be caused by cold starts.\n\n### Worker configuration\n\nVTEX IO services use the [Cluster module from Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/api/cluster.html) for parallelism. A service starts with a main process and then creates child processes, or workers, to handle the load from requests. The number of workers is determined by the value of the `workers` parameter.\n\nA higher number of workers is recommended when more processing capacity is required to handle requests, which can reduce response times. Be aware that more workers also increase the memory usage of the service, so adjust the `memory` parameter accordingly. If your service performs well with a single worker or does not take advantage of parallelism, we recommend not declaring a `workers` value or setting it to 1.\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-service.md)\n\n[Node apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service//docs/guides/app-development-guides)[Developing services on VTEX IONext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service//docs/guides/developing-services-on-vtex-io)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Developing services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23developing-services)\n\n[Configuring services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23configuring-services)\n\n[Service configuration parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23service-configuration-parameters)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23best-practices)\n\n[Memory allocation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23memory-allocation)[Timeout settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23timeout-settings)[Replica management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23replica-management)[Route configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23route-configuration)[TTL management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23ttl-management)[Worker configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23worker-configuration)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-service.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Developing services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23developing-services)\n\n[Configuring services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23configuring-services)\n\n[Service configuration parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23service-configuration-parameters)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23best-practices)\n\n[Memory allocation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23memory-allocation)[Timeout settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23timeout-settings)[Replica management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23replica-management)[Route configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23route-configuration)[TTL management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23ttl-management)[Worker configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service/docs/guides/vtex-io-documentation-service%23worker-configuration)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_c4fd42cc
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides developer experience in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/composability)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/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/developer-experience/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/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/developer-experience/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/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/developer-experience/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/developer-experience/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/composability)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/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/developer-experience/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/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/developer-experience/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/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/developer-experience/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/developer-experience/docs/guides)\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/vtex-platform-overview)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience)\n\nDeveloper experience\n\nLearn how our platform enhances the developer experience.\n\nThis guide offers an overview of the tools and resources available to development teams. In the following sections, you will learn about the different features we provide for developers in our ecosystem and the opportunities for sharing knowledge and collaborating within the community.\n\n* [App development](#app-development): Develop and manage your VTEX IO apps.\n* [Storefront development](#storefront-development): Explore VTEX storefront solutions.\n* [Contributions and collaboration](#contributions-and-collaboration): Contribute to the VTEX ecosystem by sharing your knowledge.\n\n## App development\n\n[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) is our development platform that simplifies building, managing, and scaling ecommerce solutions by offering a comprehensive suite of tools and services, manual coding efforts while ensuring performance, scalability, and security for your projects.\n\nWithin the VTEX IO platform, you can leverage familiar technologies and frameworks like [TypeScript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/), [React](https://read.calvincode.net/reader?url=https://react.dev/), [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/), and [Node](https://read.calvincode.net/reader?url=https://nodejs.org/en) to enable rapid development and evolution. This set of technologies allows you to build custom web storefronts, customize the shopper experience, integrate with third-party systems, and create custom applications or other components to extend VTEX IO functionalities.\n\nNext, you will find an overview of the main features of the VTEX IO platform.\n\n### Developer tools\n\nLearn about the essential developer tools that equip you with the knowledge to streamline your app development journey with VTEX IO.\n\n#### Command Line Interface (CLI)\n\nA Command Line Interface (CLI) is a text-based interface used to interact with a computer system or software application by typing commands into a terminal or command prompt. It allows users to perform tasks such as running programs, managing files, and configuring settings efficiently.\n\nTo build and develop any project in VTEX IO, use the pre-configured [**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). This CLI is the starting and ending point for any development on the VTEX platform. It provides the ability to perform actions relevant to the development process, such as releasing new app versions.\n\n> For [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore) projects, we also offer the [**FastStore CLI**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli). This CLI tool connects the source code in the [@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package with your customizations and extensions for your FastStore project.\n\n#### Workspaces\n\n[Workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) are isolated environments for app development, acting as separate versions of the same account. There are three types of workspaces on VTEX:\n\n* **Master**: A unique production workspace that reflects the live store content.\n* [**Development workspaces**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace): Environments that allow testing changes in real time. They provide freedom in code development without affecting user traffic and the live store and are necessary when making changes to storefronts or developing a new VTEX IO app.\n* [**Production workspaces**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace): Mainly used to validate VTEX IO apps. These workspaces handle traffic, so they can be used to run [A/B tests](#ab-tests) and can be [promoted to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master).\n\nTo learn how to manage workspaces effectively in your projects, see the [Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices) guide.\n\n#### A/B tests\n\nAfter [installing your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) in a [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace), you can run an [A/B test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing) to compare traffic and choose the workspace that performs better in terms of user engagement and conversions.\n\n#### Builders\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) streamline the development experience by abstracting complex implementation details, enabling developers to focus on enhancing store features. Acting as bridges, builders allow different parts of an app to work together by configuring and connecting to necessary services.\n\nThere are various [types of builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders%23list-of-builders). Each is equipped with pre-built functionalities and integration options, facilitating quick feature implementation for specific tasks or functionalities. For example, some builders focus on [developing new storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder), [setting styles for your components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder) within your [Store Theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme), [publishing app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-builder), among others.\n\nBy leveraging builders, developers can extend the functionality of the VTEX platform without starting from scratch. This modular approach promotes flexibility, scalability, and efficiency in developing and customizing VTEX-based ecommerce solutions, accelerating development cycles, promoting code reusability, and facilitating rapid [deployment](#deployment) of new functionalities.\n\n#### Edition Apps\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) are collections of VTEX apps that define the functionalities available in a VTEX account. They consist of a bundle of settings, policies, backend and frontend apps, aiming to streamline the setup and management of essential configurations quickly and efficiently.\n\nWe offer two native Edition Apps:\n\n* **Edition Store**: For Store Framework stores.\n* **Edition Business**: For Legacy CMS Portal stores.\n\n> To learn how to develop your own Edition App, check the [Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app) guide.\n\n### VTEX apps\n\n[VTEX Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app) expand VTEX platform capabilities across various aspects of digital commerce, such as marketing, analytics, logistics, security, and store design.\n\nWe offer the following types of apps:\n\n* [**Storefront apps**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io): React components that enhance the functionality and user experience of your store, such as product carousels or navigation menus.\n* [**Backend apps**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service): Node or .NET Core services that enable VTEX IO apps to export HTTP routes, GraphQL resolvers, and event handlers to the server.\n* [**Pixel apps**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps): Collect user data for third-party services by running scripts on all pages of a store website.\n* [**Edition Apps**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app): Bundles of settings, policies, backend, and frontend apps encapsulated in a single app.\n\nYou can take advantage of our [VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps), which are pre-built solutions typically developed and maintained by VTEX that can be easily integrated with your store. These apps can be discovered, installed, and managed through the [VTEX App Store](#vtex-app-store).\n\nIf you can’t find an app that meets your business needs, you can create customized solutions by [developing your own VTEX app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-an-app) using the [VTEX IO](#app-development).\n\nWe provide some ready-to-use [code templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples) to simplify your development process when creating a VTEX IO app. If you choose to use one of them, you don’t need to write the boilerplate code, ensuring development agility, quality, and compliance with platform standards.\n\n> To learn about the relevant aspects to consider when developing VTEX IO apps, check the [Before creating an app for your store](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu%23before-creating-an-app-for-your-store) article.\n\n#### VTEX App Store\n\nYou can make your apps available to the VTEX ecosystem on the [VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store), a marketplace for VTEX IO plug-and-play solutions.\n\n> To learn about the homologation requirements for the VTEX App Store, check the [App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store).\n\n#### Deployment\n\nOnce a new app has been developed, it must be deployed to the VTEX IO production workspace to make it publicly available. The deployment process is the following:\n\n\n\n* [**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): Marks the beginning by releasing the app using Git, updating the version in `manifest.json`, and documenting changes in CHANGELOG.md.\n* [**Publishing**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app): The app version becomes a candidate version, ready for testing and validation in a production workspace.\n* [**Testing**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ab-tests): Run [A/B tests](#ab-tests).\n* [**Deploying**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version): Update the app version across all accounts where the app is installed.\n* [**Promoting**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master): Optional step to promote the production workspace to master.\n\nCheck [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) for more details on this flow.\n\n> To learn about app versioning in VTEX IO, check [SemVer standard](https://read.calvincode.net/reader?url=https://semver.org/) and our [Understanding app versioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version) article.\n\n## Storefront development\n\nVTEX provides different options for storefront development, each with its own characteristics, to suit your business needs:\n\n* [**FastStore**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore): Innovative storefront technology based on the [Jamstack](https://read.calvincode.net/reader?url=https://jamstack.org/) architecture. FastStore prioritizes performance and stability, offering development teams an easily maintainable solution for editing store pages.\n* [**Store Framework**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework): Composable and flexible commerce model, allowing integration of [VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps) for dynamic storefronts.\n* [**Legacy CMS Portal**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io): Legacy storefront technology that relies on HTML, CSS, and JavaScript, with code management exclusively done through the VTEX Admin. This technology is no longer available for new stores starting with VTEX.\n\n## Contributions and collaboration\n\nThe [VTEX Community](https://read.calvincode.net/reader?url=https://community.vtex.com/) is an ecosystem where our clients and partners can interact, ask questions, and exchange information. It is the go-to place to find answers and discuss VTEX products.\n\nThe VTEX Community provides forums and discussion groups where members can ask questions, share insights, and seek assistance from peers and experts. These forums cover various topics related to development, implementation, optimization, and best practices for using the VTEX IO platform.\n\nDevelopers can participate in the VTEX Community by sharing knowledge, contributing code, and collaborating with the ecosystem to improve the platform and address common challenges.\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\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-Platform-Overview/developer-experience.md)\n\n[Understanding VTEX reference architectures« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience//docs/guides/understanding-vtex-reference-architectures)[API usageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience//docs/guides/api-usage)\n\nSee also\n\n[Store FrameworkGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/store-framework)[FastStoreGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/faststore)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[App development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience%23app-development)\n\n[Developer tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience%23developer-tools)[VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience%23vtex-apps)\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience%23storefront-development)\n\n[Contributions and collaboration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience%23contributions-and-collaboration)\n\nWas this helpful?\n\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/developer-experience.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[App development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience%23app-development)\n\n[Developer tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience%23developer-tools)[VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience%23vtex-apps)\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience%23storefront-development)\n\n[Contributions and collaboration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience/docs/guides/developer-experience%23contributions-and-collaboration)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_84fd9cba
|
[
{
"role": "system",
"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 zendesk chat 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.zendesk-chat/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/api-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.zendesk-chat/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.zendesk-chat/docs/storefront-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.zendesk-chat/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.zendesk-chat/docs/troubleshooting)\n\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.zendesk-chat/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/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.zendesk-chat/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/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.zendesk-chat/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.zendesk-chat/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/guides/pixel-apps)\n\nZendesk Chat\n\nOfficial extension\n\nVersion: 1.4.2\n\nLatest version: 1.4.2\n\nThis app provides a storefront widget for the [Zendesk](https://read.calvincode.net/reader?url=https://zendesk.com/) chat functionality to comunicate with your store's customers while they navigate your store.\n\n## Before you start\n\nTo use the chat you need to have an active [Zendesk](https://read.calvincode.net/reader?url=https://zendesk.com/) account. Some features are only available for specific plans.\n\n## Installation\n\n1. Open the VTEX App Store and install the [Zendesk Chat](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-zendesk-chat/p) app on your store.\n2. On VTEX Admin, go to **Extensions Hub > App Management** and click the Zendesk Chat app settings.\n3. Fill in your Zendesk Chat's Account Key, which you can find on Zendesk following [these instructions](https://read.calvincode.net/reader?url=https://support.zendesk.com/hc/en-us/articles/4408825772698-How-do-I-find-my-Chat-Account-Key-).\n4. Click `Save`.\n5. Copy the following script and insert it into your website's HTML source code between the `<head>` tags. This code must be inserted into every page where you want to display the Web Widget. \n`1 \n<script id=\"ze-snippet\" src=\"https://static.zdassets.com/ekr/snippet.js?key=xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx> </script> \n`\n\n> Replace the key value, i.e. `xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`, according to your scenario.\n\n[Trustpilot« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.trustpilot)[ZopimNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.zopim)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.zendesk-chat%23before-you-start)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zendesk-chat/docs/apps/vtex.zendesk-chat%23installation)\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_a97a950c
|
[
{
"role": "system",
"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 zopim 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.zopim/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/api-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.zopim/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.zopim/docs/storefront-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.zopim/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.zopim/docs/troubleshooting)\n\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.zopim/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/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.zopim/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/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.zopim/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.zopim/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/guides/pixel-apps)\n\nZopim\n\nOfficial extension\n\nVersion: 1.2.3\n\nLatest version: 1.2.3\n\nVTEX Zopim first-party app\n\n## How to install\n\nOpen the VTEX App Store and install this app on your store.\n\nNow, open the app settings on your admin and fill in your Zopim's Account Key.\n\n[Zendesk Chat« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.zendesk-chat)[My Account - StoreV2 versionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.my-account)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[How to install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.zopim/docs/apps/vtex.zopim%23how-to-install)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_c696637f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides code samples in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/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/code-samples/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/code-samples/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/code-samples/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/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/code-samples/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/code-samples/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/code-samples/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/code-samples/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/code-samples/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/code-samples/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/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/code-samples/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/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/code-samples/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/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/code-samples/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/code-samples/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/code-samples/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/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/code-samples/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/code-samples/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/code-samples/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/code-samples/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/code-samples/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/code-samples/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/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/code-samples/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\nCode samples and templates\n\nSimplify your development process with ready-to-use code templates\n\n\n\nAll builders\n\nreact\n\nmessages\n\nnode\n\nstore\n\npixel\n\nscripts\n\nstyles\n\nsitemap\n\nedition\n\nvtex.carrier-tracking\n\nvtex.carrier-notifier\n\npages\n\npaymentProvider\n\nadmin\n\ngraphql\n\ncheckout-ui-custom\n\nClear\n\nApply\n\nFrontend\n\nReact app\n\nCreate custom React-based apps for your Store Theme with internationalization support.\n\nreact\n\nmessages\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/react-app-template)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\nBackend\n\nService\n\nLeverage Node.js to implement custom route handling logic.\n\nnode\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example)\n\n[View documentation](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-calling-commerce-apis-step01introduction-lang-en)\n\nScripts\n\nPixel app\n\nRun scripts in your store website to integrate with third-party solutions and services.\n\nreact\n\nstore\n\npixel\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/pixel-app-template)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\nScripts\n\nScripts app\n\nRun VTEX IO scripts in Legacy CMS stores using a custom Scripts app.\n\nscripts\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/app-scripts-example)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-1-developing-your-app)\n\nStore Framework\n\nStore Theme\n\nJumpstart the development of Store Themes with this predefined template.\n\nstyles\n\nstore\n\nsitemap\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3)\n\nStore Framework\n\nMinimum Store Theme\n\nJumpstart the development of Store Themes with this minimum template.\n\nstyles\n\nstore\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minimum-boilerplate-theme)\n\n[View documentation](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-basic-blocks-lang-en)\n\nStore Framework\n\nStore Theme robots\n\nCustomize your cross-border store's robots.txt files.\n\nsitemap\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme-robots)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)\n\nEdition App\n\nEdition App\n\nStreamline the setup of a group of VTEX accounts by creating your own Edition App.\n\nedition\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/edition-hello)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\nFulfillment\n\nCarrier Hubs - Tracking\n\nObtain tracking events from custom carriers.\n\nnode\n\nvtex.carrier-tracking\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/carrier-hubs-examples/tree/main/carrier-tracking-example)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1)\n\nFulfillment\n\nCarrier Hubs - Notifier\n\nNotify custom carriers about a dispatch order.\n\nnode\n\nvtex.carrier-notifier\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/carrier-hubs-examples/tree/main/carrier-notifier-example)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1)\n\nPayments\n\nPayment app\n\nProvide an additional verification step in your store's checkout process.\n\nreact\n\npages\n\nmessages\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/example-payment-authorization-app)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app)\n\nPayments\n\nPayment Provider Framework\n\nIntegrate custom payment providers into your VTEX store.\n\npaymentProvider\n\nnode\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/payment-provider-example)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework)\n\nSearch\n\nSearch Segment resolver\n\nSegment the search result page to present custom results for each shopper.\n\nnode\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-segment-resolver)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\nSearch\n\nSearch GraphQL Resolver\n\nExtend VTEX search capabilities with external search providers.\n\nnode\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-resolver)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe)\n\nMarketplace\n\nExternal Marketplace Integration app\n\nIntegrate with external marketplaces.\n\nreact\n\nmessages\n\nnode\n\nadmin\n\ngraphql\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex/mkp-app-template)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template)\n\nOrders\n\nOrders Feed\n\nHandle status updates from the Orders Feed.\n\nnode\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/orders-feed-example)\n\n[View documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io)\n\nBackend\n\nEvents service\n\nTrigger events based on specific actions.\n\nnode\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/events-example)\n\nBackend\n\nGraphQL app\n\nJumpstart the development of a GraphQL service.\n\nnode\n\ngraphql\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/graphql-example)\n\nAdmin\n\nAdmin app\n\nBuild a tailored frontend app for the VTEX Admin using React.\n\nadmin\n\nmessages\n\nreact\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex/admin-ui-example)\n\nCheckout\n\nCheckout UI Settings\n\nCustomize the user interface of your store's Checkout.\n\ncheckout-ui-custom\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/checkout-ui-settings)\n\nB2B\n\nBuyer Organization Supplier app\n\nSave custom data from a Buyer Organization to Master Data.\n\nnode\n\n[View GitHub repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/buyer-org-supplier)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_49f4ff58
|
[
{
"role": "system",
"content": "You are a VTEX 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 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/payments-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-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/payments-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/payments-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/payments-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/payments-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/subscriptions)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-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/payments-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/subscriptions)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-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/payments-overview/docs/guides)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/getting-started)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview)\n\nPayments\n\n> **Help us improve our documentation!** Tell us about your experience with this article by completing [this form](https://read.calvincode.net/reader?url=https://forms.gle/fQoELRA1yfKDqmAb8).\n\n## Understanding VTEX Payments architecture\n\nVTEX's payment systems offer extensive resources to support various payment methods, conditions, and integrations. See below some articles that show a little more about the concepts and our payments architecture:\n\n* [Payments introduction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide)\n* [Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol)\n* [Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods)\n* [Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows)\n\n## Developing a payment integration at VTEX\n\nOnce you understand how payments are processed on VTEX, you can join our platform by developing integrations as a payment, anti-fraud, or external gift card provider:\n\n### Payment provider integration\n\nPayment providers can implement their integrations using our [Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol). This protocol enables providers to create a payment connector that interacts with our [Gateway](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-a-payment-gateway--2KH9Wdi7F6swOU4amECSOk) and contains the endpoints described in our [Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23overview). Besides developing the connector, providers must also test them and ensure they follow the required security standards before they can be available to the stores.\n\nTo learn all the steps necessary to develop and customize your payment integration on our platform, access the following articles:\n\n* [Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex)\n* [Payments configuration guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides)\n\n### Anti-fraud provider integration\n\nAnti-fraud solutions are essential to ensure secure payment transactions by carrying out risk analyses. VTEX offers integration capabilities for anti-fraud systems through the [Anti-fraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works). This protocol is an agreement between VTEX and providers, defining a set of rules that must be implemented during the development of integrations. Each integration must include a set of endpoints defined in our [Anti-fraud Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol%23overview).\n\n### External gift card provider integration\n\nOn VTEX, gift cards are treated as a payment method, and their transactions are processed at Checkout. In addition to [our native solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api), VTEX allows external gift card providers to implement integrations using our Giftcard Provider Protocol. Through this protocol, providers can develop a middleware containing the endpoints described in our [Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol%23overview) and connect with our [Giftcard Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api%23overview). You can check more details about gift cards in the articles below:\n\n* [Gift card introduction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide)\n* [Gift card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture)\n* [Managing VTEX gift cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-vtex-gift-cards)\n\nContributors\n\n4\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/payments-overview.md)\n\n[Checkout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview//docs/guides/checkout-overview)[FulfillmentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview//docs/guides/fulfillment)\n\nContributors\n\n4\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Understanding VTEX Payments architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview%23understanding-vtex-payments-architecture)\n\n[Developing a payment integration at VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview%23developing-a-payment-integration-at-vtex)\n\n[Payment provider integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview%23payment-provider-integration)[Anti-fraud provider integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview%23anti-fraud-provider-integration)[External gift card provider integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview%23external-gift-card-provider-integration)\n\nWas this helpful?\n\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/payments-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Understanding VTEX Payments architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview%23understanding-vtex-payments-architecture)\n\n[Developing a payment integration at VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview%23developing-a-payment-integration-at-vtex)\n\n[Payment provider integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview%23payment-provider-integration)[Anti-fraud provider integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview%23anti-fraud-provider-integration)[External gift card provider integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview/docs/guides/payments-overview%23external-gift-card-provider-integration)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_19163237
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides understanding master data in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/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/understanding-master-data/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/understanding-master-data)\n\n[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/master-data-components)\n\n[Master Data infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/master-data-infrastructure)\n\n[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/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/understanding-master-data/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/understanding-master-data/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/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/understanding-master-data/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/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/understanding-master-data/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/understanding-master-data)\n\n[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/master-data-components)\n\n[Master Data infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/master-data-infrastructure)\n\n[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/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/understanding-master-data/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/understanding-master-data/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/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/understanding-master-data/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data/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/understanding-master-data//docs/guides/master-data)[Master Data componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-master-data//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_bfdc598f
|
[
{
"role": "system",
"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 price 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-price/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-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/apps/vtex.product-price/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/guides/basic-components)\n\nProduct Price\n\nOfficial extension\n\nVersion: 1.33.0\n\nLatest version: 1.33.0\n\n[](#contributors-)\n\nThe Product Price app exports blocks related to the product price, such as list price, selling price, and savings.\n\n\n\n> Currently, **Product Price is the only app that provides product price blocks for your theme**. The [Product Summary Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryprice) block from the [Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary/) app and the [Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productprice/) block from [Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components/) have been deprecated.\n\n## Configuration\n\n### Step 1 - Adding the Product Price app to your theme dependencies\n\nIn the theme's `manifest.json` file, add the Product Price app as a dependency:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.product-price\": \"1.x\" \n\n3\n\n} \n\n`\n\nNow, you can use all the blocks exported by the `product-price` app. See the full list below:\n\n| Block name | Description |\n| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| product-list-price | Renders the product list price. This block will not be rendered if it is equal to or less than the product selling price. |\n| product-selling-price | Renders the product selling price. |\n| product-spot-price | Renders the product spot price (if it is equal to the selling price, the block is not rendered). This block finds the spot price by looking for the lowest price of all installment options. |\n| product-installments | Renders the product installments. If more than one option is available, the one with the highest number of installments will be displayed by default. |\n| product-installments-list | Renders all the installments of the payment system with the most installment options by default. |\n| product-installments-list-item | Renders an installment option from the product-installments-list-item. |\n| product-price-savings | Renders the product price savings, if there are any. It can show the discount percentage or the total amount of the savings. |\n| product-spot-price-savings | Renders the product spot price savings, if there are any. It can show the discount percentage or the total amount of the savings. |\n| product-list-price-range | Renders the product list price range. It follows the same logic applied to the ListPrice: if its value equals the product selling price, this block is not rendered. |\n| product-selling-price-range | This is the product selling price range. |\n| product-seller-name | Renders the name of the product seller. |\n| product-price-suspense | Renders a fallback component when the price is loading and its children block when it is not loading. This block is handy when the store works with asynchronous prices. |\n\nAll blocks listed above use product price data fetched from the store catalog. To learn more, please read the [Pricing module overview](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/precos-101--6f8pwCns3PJHqMvQSugNfP).\n\n### Step 2 - Adding the Product Price blocks to your theme templates\n\nTo add the Product Price blocks to your theme, you just need to declare them as children of the `product-summary.shelf` exported by the [Product Summary](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/content-blocks/vtex.product-summary@2.52.3) app, or declare them in the theme's Product template (`store.product`).\n\nNote that these blocks require a Product context to work correctly. Therefore, when declaring them as children of the `product-summary.shelf`, make sure they are in a store template in which this context is available.\n\nFor example:\n\n`1\n\n\"shelf#home\": { \n\n2\n\n \"blocks\": [\"product-summary.shelf\"] \n\n3\n\n}, \n\n4\n\n \n5\n\n\"product-summary.shelf\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"product-list-price\", \n\n8\n\n \"product-selling-price#summary\", \n\n9\n\n \"product-price-savings\", \n\n10\n\n \"product-installments\" \n\n11\n\n ] \n\n12\n\n}, \n\n`\n\nExcept for `product-price-suspense`, every block in this app only has three props in common:\n\n| Prop name | Type | Description | Default value |\n| ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| markers | \\[string\\] | IDs that you define to identify the block's rendered message and customize it using the Site Editor in the Admin. Learn how to use them by reading the documentation on [Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message). Note that a block's message can be customized using the message prop in the Store Theme source code. | \\[\\] |\n| blockClass | string | Block ID that you define to be used in [CSS customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23using-the-blockclass-property). | undefined |\n| message | string | Defines the block's default text, i.e., the block message. If you use the Site Editor in the Admin, you can also define the text message that a block will render on the UI. | undefined |\n\nFor example:\n\n`1\n\n\"product-selling-price#summary\": { \n\n2\n\n \"props\": { \n\n3\n\n \"markers\": [ \n\n4\n\n \"highlight\" \n\n5\n\n ], \n\n6\n\n \"blockClass\": \"summary\", \n\n7\n\n \"message\": \"Selling price: {sellingPriceValue}\" \n\n8\n\n } \n\n9\n\n}, \n\n`\n\nThe `product-price-savings` block has two additional props:\n\n| Prop name | Type | Description | Default value |\n| ----------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| percentageStyle | locale or compact | Set to compact to remove the white space between the number and the percent sign. It uses the pattern provided by the current locale as default. | locale |\n| minimumPercentage | number | Set the minimum value for the percentage value display. If not configured, it will display always. Example: 10 means savings less than or equal to 10% will not appear. | 0 |\n\nThe following blocks have an additional prop: `product-list-price`, `product-selling-price`, `product-spot-price`, `product-spot-price-savings`, `product-price-savings`, `product-list-price-range`, and `product-selling-price-range`. The prop is:\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------- | ------------------------------------------------------- | ------------- |\n| alwaysShow | boolean | Renders the block even when the product is unavailable. | false |\n\nFor example:\n\n`1\n\n\"product-selling-price#summary\": { \n\n2\n\n \"props\": { \n\n3\n\n \"alwaysShow\": true \n\n4\n\n } \n\n5\n\n}, \n\n`\n\nThe `product-installments-list` block has two additional props:\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| paymentSystemName | string | Allows you to filter the listed installment options by a particular payment system. If not passed, the installments of the payment system with the most installment options will be rendered. | undefined |\n| installmentsToShow | number\\[\\] | Determines the installment options you want to show to the user based on the number of installments. For example, if \\[1, 3\\] is passed as a value for this prop, only the installments options with NumberOfInstallments equal to 1 and 3 will be rendered. If a value is not passed, all options will be rendered. | undefined |\n\nThe `product-installments` block also has two additional props:\n\n| Prop name | Type | Description | Default value |\n| ------------------------ | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| installmentsCriteria | max-quantity or max-quantity-without-interest | When set to max-quantity, the block renders the installment plan with the most number of installments. When set to max-quantity-without-interest, the block renders the installment plan with the most number of installments and **no interest**. Note that if this prop is set to max-quantity-without-interest and no installment plan matches the 'without interest' criterion, the component will fall back to the default behavior. | max-quantity |\n| installmentOptionsFilter | { paymentSystemName?: string, installmentsQuantity?: number } | Allows you to define two filtering rules that will narrow down the possible installment plans the component may render. | undefined |\n\nIf you are using the asynchronous price feature, you can take advantage of `product-price-suspense` and its props:\n\n| Prop name | Type | Description | Default value |\n| --------- | ----- | ------------------------------------------------------------------ | ----------------- |\n| Fallback | block | Name of the block that will be rendered when the price is loading. | rich-text#loading |\n\nFor example:\n\n`1\n\n{ \n\n2\n\n \"rich-text#loading\": { \n\n3\n\n \"props\": { \n\n4\n\n \"text\": \"Loading...\" \n\n5\n\n } \n\n6\n\n }, \n\n7\n\n \"product-price-suspense\": { \n\n8\n\n \"props\": { \n\n9\n\n \"Fallback\": \"rich-text#loading\" \n\n10\n\n }, \n\n11\n\n \"children\": [ \n\n12\n\n \"product-list-price#summary\", \n\n13\n\n \"flex-layout.row#selling-price-savings\", \n\n14\n\n \"product-installments#summary\", \n\n15\n\n \"add-to-cart-button\" \n\n16\n\n ] \n\n17\n\n }, \n\n18\n\n \"product-summary.shelf\": { \n\n19\n\n \"children\": [ \n\n20\n\n \"stack-layout#prodsum\", \n\n21\n\n \"product-summary-name\", \n\n22\n\n \"product-rating-inline\", \n\n23\n\n \"product-summary-space\", \n\n24\n\n \"product-price-suspense\" \n\n25\n\n ] \n\n26\n\n } \n\n27\n\n} \n\n`\n\n\n\n### Step 3 - Editing the block's messages\n\nEvery Product Price block uses the [ICU Message Format](https://read.calvincode.net/reader?url=https://format-message.github.io/icu-message-format-for-translators/), making it possible to fully edit the text message and variables displayed by each block.\n\nThe variable values are rendered based on the context wrapping the block, meaning it uses product data to render the price accordingly.\n\nYou can, however, define the message texts a block will render on the UI using the `message` prop as explained previously.\n\nThe `markers` prop, in turn, needs an extra configuration in the Admin's Site Editor to work correctly. When using it, do not forget to read the [Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/) documentation.\n\n\n\nIn addition, remember to take into account the message variables for each block, since you will need them to edit the desired messages using the Admin's Site Editor:\n\n* **`product-list-price`**\n\n| Message variable | Type | Description |\n| ------------------------------------- | ------- | -------------------------------------------------------------------------------------------- |\n| listPriceValue | string | List price value. |\n| listPriceWithTax | string | List price value with tax. |\n| listPriceWithUnitMultiplier | string | List price multiplied by a unit multiplier. |\n| listPriceWithTaxWithoutUnitMultiplier | string | List price with tax without unit multiplier. |\n| taxPercentage | string | Tax percentage. |\n| taxValue | string | Tax value. |\n| hasMeasurementUnit | boolean | Determines whether the product has a unit of measure (true) or not (false). |\n| measurementUnit | string | Unit of measure text. |\n| hasUnitMultiplier | boolean | Determines whether the product has a unit multiplier different from 1 (true) or not (false). |\n| unitMultiplier | string | Value of the unit multiplier. |\n\n* **`product-selling-price`**\n\n| Message variable | Type | Description |\n| ---------------------------------------- | ------- | -------------------------------------------------------------------------------------------- |\n| sellingPriceValue | string | Selling price value. |\n| sellingPriceWithTax | string | Selling price with tax. |\n| sellingPriceWithUnitMultiplier | string | Selling price multiplied by a unit multiplier. |\n| sellingPriceWithUnitMultiplierAndTax | string | Selling price multiplied by a unit multiplier and added tax. |\n| sellingPriceWithTaxWithoutUnitMultiplier | string | Selling price with tax without unit multiplier. |\n| taxPercentage | string | Tax percentage. |\n| hasListPrice | boolean | Determines whether the product has a list price (true) or not (false). |\n| taxValue | string | Tax value. |\n| hasMeasurementUnit | boolean | Determines whether the product has a unit of measure (true) or not (false). |\n| measurementUnit | string | Unit of measure text. |\n| hasUnitMultiplier | boolean | Determines whether the product has a unit multiplier different from 1 (true) or not (false). |\n| unitMultiplier | string | Value of the unit multiplier. |\n\nYou can use the `product-selling-price` `sellingPriceWithUnitMultiplier`, `hasMeasurementUnit`, `unitMultiplier`, and `measurementUnit` variables together to render the unit of measure and unit multiplier on products that have it.\n\nFor example:\n\n`1\n\n{ \n\n2\n\n \"product-selling-price\": { \n\n3\n\n \"props\": { \n\n4\n\n \"message\": \"{sellingPriceWithUnitMultiplier}{hasMeasurementUnit, select, true { / {hasUnitMultiplier, select, true {{unitMultiplier}} false {}} {measurementUnit}} false {}}\" \n\n5\n\n } \n\n6\n\n } \n\n7\n\n} \n\n`\n\nAccording to the example above, products with a unit of measure and a unit multiplier would be rendered as follows:\n\n`$24.00 / 2 oz`\n\n> _Note that the unit of measure and unit multiplier would be properly rendered alongside their price._\n\nStill, in the example, products that do not have a unit of measure and a unit multiplier will only render their price:\n\n`$24.00`\n\n* **`product-spot-price`**\n\n| Message variable | Type | Description |\n| ---------------- | ------ | ----------------- |\n| spotPriceValue | string | Spot price value. |\n\n* **`product-installments` and `product-installments-list-item`**\n\n| Message variables | Type | Description |\n| ---------------------- | ------- | -------------------------------------------------------------------------- |\n| spotPriceValue | string | Spot price value. |\n| installmentsNumber | string | Number of installments. |\n| installmentValue | string | Amount of each installment. |\n| installmentsTotalValue | string | Total amount of installments. |\n| interestRate | string | Interest rate. |\n| paymentSystemName | string | Payment system for the installments. |\n| hasInterest | boolean | Determines whether the installments have interest (true) or not (false). |\n| hasMoreThanOne | boolean | Determines whether there is more than 1 installment (true) or not (false). |\n\n* **`product-price-savings`**\n\n| Message variables | Type | Description |\n| ------------------ | ------ | ------------------------------------------------------------------------- |\n| previousPriceValue | string | Previous price value (list price). |\n| newPriceValue | string | New price value (selling price). |\n| savingsValue | string | Difference between the previous product price and the new one. |\n| savingsWithTax | string | Difference between the previous product price and the new one with taxes. |\n| savingsPercentage | string | Percentage of savings. |\n\n* **`product-spot-price-savings`**\n\n| Message variables | Type | Description |\n| -------------------------- | ------ | ---------------------------------------------------------------------------- |\n| previousPriceValue | string | Previous price value (list price). |\n| newSpotPriceValue | string | New price value (spot price). |\n| spotPriceSavingsValue | string | Difference between the previous product price and the spot price. |\n| spotPriceSavingsWithTax | string | Difference between the previous product price and the spot price with taxes. |\n| spotPriceSavingsPercentage | string | Percentage of savings. |\n\n* **`product-list-price-range`**\n\n| Message variables | Type | Description |\n| ----------------- | ------ | ----------------------------------------------------------- |\n| minPriceValue | string | Value of the cheapest list price SKU. |\n| maxPriceValue | string | Value of the most expensive list price SKU. |\n| minPriceWithTax | string | Value of the cheapest list price SKU with tax. |\n| maxPriceWithTax | string | Value of the most expensive list price SKU with tax. |\n| listPriceValue | string | Value of the list price of the only SKU available. |\n| listPriceWithTax | string | Value of the list price of the only SKU available with tax. |\n\n* **`product-selling-price-range`**\n\n| Message variables | Type | Description |\n| ------------------- | ------ | -------------------------------------------------------------- |\n| minPriceValue | string | Value of the cheapest selling price SKU. |\n| maxPriceValue | string | Value of the most expensive selling price SKU. |\n| minPriceWithTax | string | Value of the cheapest selling price SKU with tax. |\n| maxPriceWithTax | string | Value of the most expensive selling price SKU with tax. |\n| sellingPriceValue | string | Value of the selling price of the only SKU available. |\n| sellingPriceWithTax | string | Value of the selling price of the only SKU available with tax. |\n\n* **`product-seller-name`**\n\n| Message variable | Type | Description |\n| ---------------- | ------ | ------------------------------- |\n| sellerName | string | The name of the product seller. |\n\nIn the gif example above, the block first displayed a `Save $224.40` message. By editing the exported message, it now renders a `You are saving: $224.40 (37%)` message thanks to the changes performed through the Site Editor in the Admin:\n\n\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS handles for store customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS handles |\n| ------------------------------------ |\n| installmentValue |\n| installmentsListContainer |\n| installmentsNumber |\n| installmentsTotalValue |\n| installments |\n| interestRate |\n| listPrice' |\n| listPrice--isUnavailable |\n| listPriceRangeMaxValue |\n| listPriceRangeMaxWithTax |\n| listPriceRangeMinValue |\n| listPriceRangeMinWithTax |\n| listPriceRangeUniqueValue |\n| listPriceRangeUniqueWithTax |\n| listPriceRange |\n| listPriceRange--isUnavailable |\n| listPriceValue |\n| listPriceWithTax |\n| newPriceValue |\n| newSpotPriceValue |\n| paymentSystemName |\n| previousPriceValue |\n| savingsPercentage |\n| savingsValue |\n| savingsWithTax |\n| savings |\n| savings--isUnavailable |\n| sellerName |\n| sellerNameContainer |\n| sellerNameContainer--isDefaultSeller |\n| sellingPrice--hasListPrice |\n| sellingPrice--isUnavailable |\n| sellingPriceRangeMaxValue |\n| sellingPriceRangeMaxWithTax |\n| sellingPriceRangeMinValue |\n| sellingPriceRangeMinWithTax |\n| sellingPriceRangeUniqueValue |\n| sellingPriceRangeUniqueWithTax |\n| sellingPriceRange |\n| sellingPriceRange--isUnavailable |\n| sellingPriceRange--hasListPrice |\n| sellingPriceValue |\n| sellingPriceWithTax |\n| sellingPrice |\n| spotPriceSavingsPercentage |\n| spotPriceSavingsValue |\n| spotPriceSavingsWithTax |\n| spotPriceSavings |\n| spotPriceSavings--isUnavailable |\n| spotPriceValue |\n| spotPrice |\n| spotPrice--isUnavailable |\n| taxPercentage |\n\n[Product List« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-list)[Product QuantityNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-quantity)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-price%23configuration)\n\n[Step 1 - Adding the Product Price app to your theme dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-price%23step-1-adding-the-product-price-app-to-your-theme-dependencies)[Step 2 - Adding the Product Price blocks to your theme templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-price%23step-2-adding-the-product-price-blocks-to-your-theme-templates)[Step 3 - Editing the block's messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-price%23step-3-editing-the-blocks-messages)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price/docs/apps/vtex.product-price%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_3d4dd8a6
|
[
{
"role": "system",
"content": "You are a VTEX 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 billing options in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/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-billing-options/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/docs/guides/vtex-io-documentation-builders)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/docs/guides/vtex-io-documentation-builders)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/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-billing-options/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-billing-options/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-billing-options/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-billing-options/docs/app-development)\n\nProject structure\n\n[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options)\n\nBilling Options\n\nThe `billingOptions` field is part of the `manifest.json` file of an app and is used to define all the necessary metadata for distributing an app on the VTEX ecosystem. The `billingOptions` field allows you to charge for an app, make it public, and determine its pricing settings.\n\nPlease note that apps without `billingOptions` in the `manifest.json` file are **private**, meaning they are only visible and available for installation in the account where they were published.\n\n> Setting your app's billing model is a necessary step to distribute your app on the VTEX ecosystem. Without the `billingOptions` definition, the visibility of your app is restricted to the account where it was published. Learn how to configure the `billingOptions` field in [Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model) according to your scenario.\n\nRefer to the following sections to find more details on the properties that comprise the `billingOptions` field.\n\n## Properties\n\n| Property | Type | Description | Valid example |\n| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |\n| type | enum | Defines how the app is charged. Possible values are: free (app is free of charge), billable (app charges according to one of its plans), or sponsored (app is meant to be used only by a [Sponsor account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account) and its children). | free |\n| support | object | Provides a support request channel between the app’s user and its vendor. To know more, check out the [support object](#support-object) section below. | undefined |\n| availableCountries | array | Defines the countries ID (ISO) where the app can be installed and where the vendor ensures support. | \\[\"BRA\", \"USA\", \"GBR\"\\] or \\[\"\\*\"\\] _(meaning that the app is available in any country)_ |\n| plans | array | **Optional property.** Defines (in an object array) a predefined subscription plan. To know more, check out the [plans array](#plans-array) section below. | undefined |\n\n### **`support` object:**\n\n| Property | Type | Description | Valid example |\n| -------- | ------ | ---------------------------------------------------------------------------------------------------- | ------------------- |\n| email | string | Email address where users can request support. | example@example.com |\n| url | string | **Optional property.** URL where users can request support. | example.com/support |\n| phone | string | **Optional property.** Phone number (in full international format) for users to request support.\\*\\* | +5521988887777 |\n\nValid example of the object:\n\n`1\n\n\"support\": { \n\n2\n\n \"url\": \"https://example.com/support\", \n\n3\n\n \"email\": \"example@example.com\", \n\n4\n\n \"phone\": \"+5521988887777\" \n\n5\n\n}, \n\n`\n\n### **`plans` array:**\n\n| Property | Type | Description | Valid example |\n| -------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |\n| id | string | Unique plan identifier containing one or more letters or numbers from the English alphabet. | BRAplan23, planShipping |\n| currency | string | A valid [ISO 4217](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F4217) currency code to be used for the app’s subscription value. Currently, only BRL and USD are supported. | BRL, USD |\n| price | object | Contains subscription pricing values for the billable app. All values follow the same unit set in the currency prop. For more info, check out the [price object](#price-object) section below. | undefined |\n\nValid example of the object:\n\n`1\n\n\"plans\": [{ \n\n2\n\n \"id\": \"BRAplan23\", \n\n3\n\n \"currency\": \"BRL\", \n\n4\n\n \"price\": {...} \n\n5\n\n}] \n\n`\n\n* **`price` object:**\n\n| Property | Type | Description | Valid example |\n| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| subscription | number | The subscription’s _monthly_ price. This property accepts values with or without cents. Examples: 10 (10 dollars), 60.25 (60 dollars and 25 cents), 0.9 (90 cents). | 19.99 |\n| metrics | array | Defines (in an object array) the criteria on which the variable fee will be based on, according to the app’s use. Use this property only if you also want to charge your app users based on their usage (in addition to the subscription fee). To know more, check out the [metrics array](#metrics-array) section below. | undefined |\n\nValid example of the object:\n\n`1\n\n\"price\" { \n\n2\n\n \"subscription\": 50, \n\n3\n\n \"metrics\": [{...}] \n\n4\n\n} \n\n`\n\n### **`metrics` array:**\n\n| Property | Type | Description | Valid example |\n| --------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |\n| id | string | Unique metric identifier (across all metrics within the plan) containing one or more _letters_ or _numbers_ from the English alphabet. | CreditMetric23 |\n| ranges | array | Defines (in an object array) the range used to calculate the app’s use and the variable fee that users should be charged. To know more, check out the [ranges array](#ranges-array) section below. | undefined |\n| customURL | string | Reliable URL address containing information on how to get the metric value. | mycredit.com/app/3/metric-value |\n\nValid example of the object:\n\n`1\n\n{ \n\n2\n\n \"id\": \"notificationSent\", \n\n3\n\n \"ranges\": [{...}], \n\n4\n\n \"customUrl\": \"https://metrics.com/_v/metric/billing/info\" \n\n5\n\n} \n\n`\n\n### **`ranges` array:**\n\n| Property | Type | Description | Valid example |\n| ------------- | ------ | ----------------------------------------------------------------------------------------------------------------- | ---------------- |\n| multiplier | number | A positive number that is going to be multiplied by the metric value to calculate the price that will be charged. | 0.07, 1.99, 5 |\n| exclusiveFrom | number | A number that denotes the start of the range (but doesn't include that number itself in the range). | 0, 100, 33.33 |\n| inclusiveTo | number | A number that denotes the end of the range (including that number itself). | 100, 500, 999.99 |\n\nValid example of the object:\n\n`1\n\n\"ranges\": [{ \n\n2\n\n \"exclusiveFrom\": 0, \n\n3\n\n \"multiplier\": 0.08 \n\n4\n\n}] \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-billing-options.md)\n\n[Manifest« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options//docs/guides/vtex-io-documentation-manifest)[BuildersNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options//docs/guides/vtex-io-documentation-builders)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options%23properties)\n\n[support object:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options%23support-object)[plans array:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options%23plans-array)[metrics array:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options%23metrics-array)[ranges array:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options%23ranges-array)\n\nWas this helpful?\n\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-billing-options.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options%23properties)\n\n[support object:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options%23support-object)[plans array:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options%23plans-array)[metrics array:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options%23metrics-array)[ranges array:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options/docs/guides/vtex-io-documentation-billing-options%23ranges-array)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_3eaf6703
|
[
{
"role": "system",
"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 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/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/docs/api-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/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/docs/storefront-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/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/docs/troubleshooting)\n\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/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/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages)\n\n[Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/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/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/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages)\n\n[Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/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/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/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/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/guides/functional-apps)\n\nMessages\n\nOfficial extension\n\nVersion: 1.71.0\n\nLatest version: 1.71.0\n\nThe Messages app is a GraphQL service that manages translations for React and GraphQL apps.\n\n## App behavior\n\n**Messages** aggregates all the translation services in VTEX IO. Given a message to translate, **Messages** will get the translation in the order presented below.\n\n1. User-defined content.\n2. Translations defined in the app's `/messages` folder.\n3. Automatic translation system.\n\nIf a translation is not found in one step, **Messages** proceeds to the next in the list.\n\n### Settings\n\nThe **Messages** app has some optional configurations. By default, it will translate every string to every available language.\n\nTo configure the app settings, follow these steps:\n\n1. In the VTEX Admin, go to **Apps** \\> **Extensions Hub** \\> **App Management**.\n2. In the list of installed apps, search for **VTEX Messages**.\n3. Click `Settings` ⚙️.\n4. Edit the settings as wanted.\n5. Click `Save`.\n\nSee the details about all the settings in the table below:\n\n| Setting | Type | Description |\n| ----------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| Enable User Translations | boolean | Enable user translations of apps' messages. Default: true. |\n| Default Language | string | The default language you want to fallback to. If the value is \\*, all languages will be supported. Default: \\*. |\n| Supported Languages | array of strings | List of supported languages. If the requested language is unsupported, the Messages app will translate to the default language. |\n| Two Factor URL | string | URL to receive a token for authorizing message saves. |\n| Enable Automatic Translations | boolean | Enable the items not translated manually on your site to be automatically translated. Default: true. |\n\n## Translating a frontend app\n\n### Requisites\n\nTo translate a frontend app, ensure you are using the [Messages builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder) at version `1.x` and the [React builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder) at version `3.x`.\n\n### Defining the app translations\n\nCreate a folder named `/messages` in your app's root directory. This folder will contain all translations for your app. For example, to support the Italian language, add a file called `it.json` with the following content:\n\n`1\n\n{ \n\n2\n\n \"New user greeting\": \"Ciao\" \n\n3\n\n} \n\n`\n\nThis is a key-value JSON where the key is the id used in `<FormattedMessage>` of React Intl, and the value is the desired translation. Since translating all strings manually is an arduous process, we recommend using automatic translation for languages not part of your target audience.\n\nTo leverage better automatic translations, create a file called `context.json` in your `/messages` folder with the following content:\n\n`1\n\n{ \n\n2\n\n \"New user greeting\": \"Greeting new user that logged in\" \n\n3\n\n} \n\n`\n\nThis file works as a translation disambiguation. For example, the Italian word \"Ciao\" could mean both \"Hello\" and \"Goodbye\", so the description ensures the translation is accurate.\n\n> The `context.json` file is necessary and has to contain all translation keys.\n\n**Best practice**: Use keys with spaces for better organization. If there is no translation to the target language for that key, the Messages app will attempt to fall back to the English translation (defined by the user or in the `en.json` file). If that fails, the key will be translated to the target language using the automatic translation system.\n\n## Translating the response of a backend app\n\nTranslating our backend app's response can be done in two steps:\n\n1. Write `scalar IOMessage` in the first line of the app’s `schema.graphql` file.\n2. Change from `String` to `IOMessage` the data that you want to be translatable.\n\n`IOMessage` is a built-in [GraphQL object type](https://read.calvincode.net/reader?url=https://graphql.org/learn/schema/%23object-types-and-fields) used for translatable strings. For more information, see the [IOMessage](#iomessage) section.\n\nSuppose that you have a GraphQL app that has the following schema:\n\n`1\n\ntype Product { \n\n2\n\n id: ID \n\n3\n\n name: String \n\n4\n\n categories: [String] \n\n5\n\n} \n\n6\n\n \n7\n\nType Query { \n\n8\n\n productById(id: ID): Product \n\n9\n\n} \n\n`\n\nTo return a product with a translatable name and categories, your app's schema should be like the one below:\n\n`1\n\n+ scalar IOMessage \n\n2\n\n+ \n\n3\n\ntype Product { \n\n4\n\n id: ID \n\n5\n\n name: IOMessage \n\n6\n\n categories: [IOMessage] \n\n7\n\n} \n\n8\n\n \n9\n\nType Query { \n\n10\n\n productById(id: ID): Product \n\n11\n\n} \n\n`\n\nNow, these fields will automatically be translated into any supported language, without requiring changes to how data is returned or stored.\n\n## Exporting custom translations\n\nIt's also possible to export custom translations to **Messages** via a custom app. This can be handy if you want to translate external API data, like the [Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview).\n\nTo export such configurations:\n\n1. Create an app with [Messages builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder) at version `1.x`.\n2. Create a `/messages` folder in the app's root directory with the desired translations.\n\nFor example, if the product name \"Cool Shorts\" is automatically translated into Portuguese as \"_Bermuda legal_\", but you want to override it, create the following files in your app's `/messages` folder:\n\ncontext.json\n\n`1\n\n{ \n\n2\n\n \"Cool Shorts\": \"A clothing item (shorts) that is cool.\" \n\n3\n\n} \n\n`\n\npt.json\n\n`1\n\n{ \n\n2\n\n \"Cool Shorts\": \"Super Bermuda\" \n\n3\n\n} \n\n`\n\nNow, \"Cool Shorts\" will be translated to \"_Super Bermuda_\" in Portuguese, overriding the automatic translation.\n\n## Message API\n\nThis section provides an overview of how to work with the Messages API. For more details, see the [Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api) reference.\n\n### IOMessage\n\nThe IOMessage is an [object type](https://read.calvincode.net/reader?url=https://graphql.org/learn/schema/%23object-types-and-fields) built into our GraphQL infrastructure used for translatable strings. It has the following structure:\n\n`1\n\ntype IOMessage { \n\n2\n\n content: String! \n\n3\n\n description: String \n\n4\n\n from: String \n\n5\n\n} \n\n`\n\n* `content`: String that will be translated.\n* `description`: Description of the context of the string.\n* `from`: Source language of content.\n\nNote that, if your GraphQL resolver returns the IOMessage object structure instead of a raw string, **Messages** would have more information allowing it to generate an even better translation. On the other hand, if your backend does not provide such info, you can return a raw string and the other parameters will be populated automatically.\n\n### Behaviors\n\n* The automatic translations service supports [ICU MessageFormat](https://read.calvincode.net/reader?url=http://format-message.github.io/icu-message-format-for-translators/), however each component of the message is translated independently. Therefore, the automatic translation is not optimal and it is better to have a defined translation for complex ICU messages.\n* If a message has brackets (`{`), **Messages** will assume it is an ICU Message. Therefore, if a bracket is part of your string, you should escape it (`\\{`).\n* When trying to translate a React app message to a language that does not have a JSON file in the `/messages` folder, the **Messages** app sends the value defined in the `en.json` file to the automatic translation service. Therefore, it is a good practice to have this file in all React apps.\n* When translating a message to a full locale (e.g. `pt-BR`) and the respective file (`pt-BR.json`) is not found, **Messages** will try using the JSON file with only the language (in this example, `pt.json`).\n\n[Checkout UI Settings« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.checkout-ui-settings)[Messages GraphQL APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages/messages-graphql-api)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[Messages Graphql APIVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages@1.71.0/messages-graphql-api)\n\nON THIS PAGE\n\n[App behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages%23app-behavior)\n\n[Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages%23settings)\n\n[Translating a frontend app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages%23translating-a-frontend-app)\n\n[Requisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages%23requisites)[Defining the app translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages%23defining-the-app-translations)\n\n[Translating the response of a backend app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages%23translating-the-response-of-a-backend-app)\n\n[Exporting custom translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages%23exporting-custom-translations)\n\n[Message API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages%23message-api)\n\n[IOMessage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages%23iomessage)[Behaviors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/docs/apps/vtex.messages%23behaviors)\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_19924b73
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides using node 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/using-node-clients/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-clients/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-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/using-node-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/using-node-clients/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-clients/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/vtex-io-documentation-clients)\n\n[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-clients/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-clients/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-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/using-node-clients/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-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/using-node-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/using-node-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/using-node-clients/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-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/using-node-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/using-node-clients/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-clients/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/vtex-io-documentation-clients)\n\n[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-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/using-node-clients/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-clients/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-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/using-node-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/using-node-clients/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/app-development-guides)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/vtex-io-documentation-clients)\n\n[Using Clients in Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/using-node-clients)\n\nUsing Node Clients\n\nLearn how to use Clients in your VTEX IO app for interaction with both internal and external services.\n\nIn VTEX IO Services, Node [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) are powerful tools that enable you to seamlessly interact with both internal and external services. These clients play a crucial role in tasks such as making API requests, fetching data, and performing various operations within your VTEX IO apps. This guide will walk you through the effective utilization of Node Clients.\n\nFor this guide, note that VTEX IO Services exports functions that receive a `context` object. These functions can be resolver functions for GraphQL fields, middlewares for an HTTP server, or event handlers. In all cases, the Service receives a `ctx` object of type [Context](https://read.calvincode.net/reader?url=https://github.com/vtex/node-vtex-api/blob/master/src/service/worker/runtime/typings.ts), and it is within `ctx.clients` where you will find your Clients.\n\n## Before you begin\n\nBefore diving into using Clients within your VTEX IO app, ensure you have the following prerequisites in place:\n\n* **VTEX IO development workspace:** Ensure you have a VTEX IO development workspace set up. For more information, refer to [Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace).\n* **TypeScript Familiarity:** This guide assumes you have a basic understanding of TypeScript, as we'll be using the `node` [Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) to develop with TypeScript. For more information, refer to [Typescript's official documentation](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/).\n* **Understanding of Clients:** Clients play a crucial role in facilitating interactions between your application and both external and internal services. For more information, refer to [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients).\n\n## Using native `@vtex/api` Clients\n\n1. Start a new VTEX IO app using the `node` builder and open the project using your preferred code editor.\n2. Open the terminal and change to your app's `node` folder.\n3. Install the `@vtex/api` package by running the following command: \n`1 \nyarn add @vtex/api \n`\n4. In your app's handlers and middlewares, access the desired Clients via the `ctx` object. Here's an example of accessing the `@vtex/api` native `licenseManager` Client: \n`1 \nexport const authorize = async (ctx: Context) { \n2 \n const { clients: { licenseManager } } = ctx \n3 \n ... \n4 \n const data = await licenseManager.canAccessResource(/*...*/) \n5 \n} \n`\n\n## Using native `@vtex/clients` Clients\n\nThe [@vtex/clients](https://read.calvincode.net/reader?url=https://github.com/vtex/io-clients) package exports Clients, Client Factories and TypeScript typings that help you connect a VTEX IO app with VTEX Core Commerce modules.\n\n1. Start a new VTEX IO app using the `node` builder and open the project using your preferred code editor.\n2. Open the terminal and change to your app's `node` folder.\n3. Install the `@vtex/api` package by running the following command: \n`1 \nyarn add @vtex/api \n`\n4. Install the `@vtex/clients` package by running the following command: \n`1 \nyarn add @vtex/clients \n`\n5. Check the list of VTEX IO Clients available in the `@vtex/clients` package. Refer to [List of native Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients%23list-of-native-clients) and choose whether to use a Factory or an individual Client based on your requirements.\nUsing individual Clients\n1. Create a `node/clients/index.ts` file and import the desired Client. \n`1 \nimport { Catalog } from '@vtex/clients' \n`\n2. In `node/clients/index.ts`, define a class called `Clients` that extends `IOClients`. This class is used to organize and configure your custom Clients. Within the Clients class, declare a `get` property for each of your custom Clients. This property allows you to access a specific Client by name. In our example, we've created a client named `catalog` that uses the `Catalog` class. \n`1 \nimport { IOClients } from \"@vtex/api\"; \n2 \nimport { Catalog } from '@vtex/clients' \n3 \n \n4 \nexport class Clients extends IOClients { \n5 \n public get catalog() { \n6 \n return this.getOrSet('catalog', Catalog) \n7 \n } \n8 \n} \n`\n3. In your app's handlers and middlewares, access the desired Clients via the `ctx` object. Here's an example of accessing the `catalog` client and its `getSkuById` method: \n`1 \nctx.clients.catalog.getSkuById(...) \n`\nUsing Client Factories\n1. Create a `node/clients/index.ts` file and import the desired factory. For example: \n`1 \nimport { masterDataFor } from '@vtex/clients' \n`\n2. Follow the instructions for each factory, using its methods to create a Client class. Refer to [Creating a Master Data CRUD app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app) for more information on how to use the Master Data factory.\n3. In `node/clients/index.ts`, define a class called `Clients` that extends `IOClients`. This class is used to organize and configure your custom Clients. Within the Clients class, declare a `get` property for each of your custom Clients. This property allows you to access a specific Client by name. In our example, we've created a client named `books` that uses the `BooksClient` class. \n`1 \nimport { IOClients } from \"@vtex/api\"; \n2 \nconst BooksClient = masterDataFor<MyBookType>('books') \n3 \n \n4 \nexport class Clients extends IOClients { \n5 \n public get books() { \n6 \n return this.getOrSet('books', BooksClient) \n7 \n } \n8 \n} \n`\n4. In your app's handlers and middlewares, access the desired Clients via the `ctx` object. Check the following example where we access the `books` client and its `save` method: \n`1 \nctx.clients.books.save({ name: 'Example Book' }) \n`\n\n## Using custom Clients\n\nIf you have developed custom Clients for a specific need, take the following steps to use them in your VTEX IO app.\n\n> For a practical example, you can refer to how the `StatusClient` is set up in the [service-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example).\n\n1. After completing the steps in the [Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients) guide, import the `Clients` class to the `node/index.ts` file. \n`1 \nimport { Clients } from \"./clients\"; \n`\n2. Create or edit the `clients` object of type `ClientsConfig<Clients>` from `@vtex/api`. This code sets up the configuration for Clients available in `ctx.clients`. It specifies an `implementation` property as `Clients`, which points to the custom Clients imported in the previous step, providing access to your custom Clients and their functionality. \n`1 \nimport type { ClientsConfig } from \"@vtex/api\"; \n2 \n \n3 \nconst clients: ClientsConfig<Clients> = { \n4 \n implementation: Clients, \n5 \n options: { \n6 \n default: { \n7 \n retries: 2, \n8 \n timeout: 2000, \n9 \n }, \n10 \n }, \n11 \n}; \n` \nNote that inside the `options` property, there's a `default` key with default Client options. These options include specifying the number of retries and the timeout for HTTP requests. See the [Options](#options) table for more options. All IO Clients will be initialized with these options unless otherwise specified.\n3. (Optional) In the `node/index.ts` file, consider adding a type declaration to improve type safety and code clarity. This declaration helps you define the `Context` type, which is based on `ServiceContext<Clients, State>`. \n`1 \nimport type { ServiceContext } from \"@vtex/api\"; \n2 \n \n3 \ndeclare global { \n4 \n type Context = ServiceContext<Clients, State>; \n5 \n} \n`\n4. In the `node/index.ts` file, export a new Service that defines route handlers and client options. \n`1 \nexport default new Service<Clients, State>({ \n2 \n clients, \n3 \n routes: { \n4 \n ... \n5 \n }, \n6 \n}) \n` \n> For more information on how to set up routes, refer to the [Routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns) guide.\n5. Now, in your app's handlers and middlewares, use the `clients` object from the `ctx` to access your custom Client. Check the following example where we access the custom `github` Client in the `authorize` function. \n`1 \nexport const authorize = async (ctx: Context) { \n2 \n const { clients: { github } } = ctx \n3 \n ... \n4 \n const data = await github.getUser(/*...*/) \n5 \n} \n`\n\n### Options\n\nThe table below provides a detailed description of the available options for configuring your custom Client:\n\n| Option | Description |\n| ----------------------------- | ----------------------------------------------------------------------------------- |\n| authType | Specifies the authentication type. |\n| timeout | Sets the request timeout duration in milliseconds. |\n| memoryCache | Configures a memory cache layer for caching data. |\n| diskCache | Configures a disk cache layer for caching data. |\n| baseURL | Defines the base URL for making requests. |\n| retries | Specifies the number of times a request should be retried in case of failure. |\n| exponentialTimeoutCoefficient | Configures the coefficient for exponential timeout backoff strategy. |\n| initialBackoffDelay | Sets the initial delay before starting exponential backoff retries in milliseconds. |\n| exponentialBackoffCoefficient | Configures the coefficient for exponential backoff retries. |\n| metrics | Specifies an object for accumulating metrics related to requests. |\n| concurrency | Defines the maximum number of concurrent requests. |\n| headers | Sets default headers to be sent with every request. |\n| params | Sets default query string parameters to be sent with every request. |\n| middlewares | Configures an array of middleware functions for request processing. |\n| verbose | Enables or disables verbose logging for requests and responses. |\n| name | Defines a custom name for the instance. |\n| serverTimings | Sets server timings for measuring request and response times. |\n| httpsAgent | Configures the HTTPS agent for making requests over SSL/TLS. |\n\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/back-end-development-guides/using-node-clients.md)\n\n[Connecting to VTEX Core Commerce APIs« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients//docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)[Receiving Catalog Changes on VTEX IONext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients//docs/guides/how-to-receive-catalog-changes-on-vtex-io)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/using-node-clients%23before-you-begin)\n\n[Using native @vtex/api Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/using-node-clients%23using-native-vtexapi-clients)\n\n[Using native @vtex/clients Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/using-node-clients%23using-native-vtexclients-clients)\n\n[Using custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/using-node-clients%23using-custom-clients)\n\n[Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/using-node-clients%23options)\n\nWas this helpful?\n\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/using-node-clients.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/using-node-clients/docs/guides/using-node-clients%23before-you-begin)\n\n[Using native @vtex/api Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/using-node-clients%23using-native-vtexapi-clients)\n\n[Using native @vtex/clients Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/using-node-clients%23using-native-vtexclients-clients)\n\n[Using custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/using-node-clients%23using-custom-clients)\n\n[Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients/docs/guides/using-node-clients%23options)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_78e486d3
|
[
{
"role": "system",
"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 punchout 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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-api/docs/api-reference/punchout-api/)\n\nPunchout login\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-api/docs/api-reference/punchout-api/)\n\nPunchout login\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-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/punchout-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeGet usage count for a coupon batch« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-api/docs/api-reference/promotions-and-taxes-api-v2%23get-/api/rnb/v2/pvt/coupon/usage-count/group/-groupingKey-)[PoStart VTEX user punchout flowNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-api/docs/api-reference/punchout-api%23post-/api/authenticator/punchout/start)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d21212d9
|
[
{
"role": "system",
"content": "You are a VTEX 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 rendering a badge in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-rendering-a-badge/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-rendering-a-badge/docs/api-reference)\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-rendering-a-badge/docs/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-rendering-a-badge/docs/storefront-development)\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-rendering-a-badge/docs/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-rendering-a-badge/docs/troubleshooting)\n\n[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-rendering-a-badge/updates/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-rendering-a-badge/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-rendering-a-badge/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/docs/guides/store-framework-using-advanced-layouts)\n\n[Building a Carousel using Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout)\n\n[Creating a Quickview using Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-creating-a-quickview-using-modal-layout)\n\n[Creating modals using icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-creating-modals-using-icons)\n\n[Rendering a badge on top of a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-rendering-a-badge)\n\n[Using Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-using-flex-layout)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/updates/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-rendering-a-badge/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-rendering-a-badge/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/docs/guides/store-framework-using-advanced-layouts)\n\n[Building a Carousel using Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout)\n\n[Creating a Quickview using Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-creating-a-quickview-using-modal-layout)\n\n[Creating modals using icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-creating-modals-using-icons)\n\n[Rendering a badge on top of a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-rendering-a-badge)\n\n[Using Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-using-flex-layout)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/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-rendering-a-badge/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/store-framework)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/store-framework-using-advanced-layouts)\n\n[Rendering a badge on top of a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-rendering-a-badge)\n\nRendering a badge on top of a product\n\nTo render a badge on top of a [Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-product-summary) component, for example, product collection on a [Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-shelf) block, you combine the [Product Highlights app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-product-highlights/) and [Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-stack-layout).\n\n\n\n## Before you begin\n\n1. Knowledge of how the Product Summary, Product Highlights, Stack Layout, and Product collections work is required for this recipe. If you have any doubts regarding them, we strongly recommend you access their technical documentation: [Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-product-summary), [Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-product-highlights/), [Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-stack-layout) and [Collections](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-collections-beta--yJBHqNMViOAnnnq4fyOye).\n2. Ensure you have already installed [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) on your machine.\n3. Also, make sure you have as a dependency `\"vtex.product-summary\": \"2.x\"` in your theme’s `manifest.json`.\n\n## Instructions\n\n1. In your theme’s `manifest.json` file, add the Product Highlights app and Stack Layout as a dependency: \n`1 \n“dependencies” : { \n2 \n \"vtex.product-highlights\": \"2.x\", \n3 \n \"vtex.stack-layout\": \"0.x”, \n4 \n \n5 \n} \n`\n2. Open a product template you desire.\n3. Then, add the `stack-layout` component to the `blocks` list of the desired template, for example: \n`1 \n{ \n2 \n\"product-summary.shelf\": { \n3 \n \"children\": [ \n4 \n \"stack-layout#prodsum\", \n5 \n ] \n6 \n }, \n7 \n... \n`\n4. In the theme’s template, declare the `stack-layout` component, and add the `\"product-summary-image#shelf\"` and `\"vtex.product-highlights@2.x:product-highlights#collection\"` as its `children` to render the image and the badge, respectivetly. \n`1 \n\"stack-layout#prodsum\": { \n2 \n \"children\": [ \n3 \n \"product-summary-image#shelf\", \n4 \n \"vtex.product-highlights@2.x:product-highlights#collection\" \n5 \n ] \n6 \n }, \n`\n5. Then declare the props of the children. The first is `\"product-summary-image#shelf\"` props, responsible for rendering the product's image. \n`1 \n \n2 \n\"product-summary-image#shelf\": { \n3 \n \"props\": { \n4 \n \"showBadge\": true, \n5 \n \"aspectRatio\": \"1:1\", \n6 \n \"maxHeight\": 300 \n7 \n } \n8 \n }, \n`\n6. After declare the props and the children of `vtex.product-highlights@2.x:product-highlights#collection`: `product-highlight-wrapper` and `product-highlight-text`. \n> The `product-highlight-text` only renders the text already defined in the **Collection** page in a store’s Admin. For more information about it, refer to [Collections articles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-collections-beta--yJBHqNMViOAnnnq4fyOye) and the [Product Highlights app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-product-highlights%23configuration) \n`1 \n \n2 \n\"vtex.product-highlights@2.x:product-highlights#collection\": { \n3 \n \"props\": { \n4 \n \"type\": \"collection\" \n5 \n }, \n6 \n \"children\": [\"product-highlight-wrapper\"] \n7 \n }, \n8 \n \"product-highlight-wrapper\": { \n9 \n \"props\": { \n10 \n \"blockClass\": \"collection\" \n11 \n }, \n12 \n \"children\": [\"product-highlight-text\"] \n13 \n }, \n14 \n \"product-highlight-text\": { \n15 \n \"props\": { \n16 \n \"message\": \"{highlightName}\" \n17 \n } \n18 \n }, \n19 \n ... \n`\n\nOnce you have declared the blocks’ props, [link the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-linking-an-app) and see the changes live at the [Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-workspace) you are working.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-rendering-a-badge.md)\n\n[Creating modals using icons« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge//docs/guides/vtex-io-documentation-creating-modals-using-icons)[Using Flex LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge//docs/guides/vtex-io-documentation-using-flex-layout)\n\nSee also\n\n[Product SummaryVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-product-summary)[Stack LayoutVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-stack-layout)[Linking an appApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-linking-an-app)[Product HighlightsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-product-highlights)[WorkspaceApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-workspace)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-rendering-a-badge%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-rendering-a-badge%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-rendering-a-badge.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-rendering-a-badge/docs/guides/vtex-io-documentation-rendering-a-badge%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge/docs/guides/vtex-io-documentation-rendering-a-badge%23instructions)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0aabe1dc
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides shopping cart section api quick start 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/shopping-cart-section-api-quick-start-guides/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-guides/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-guides/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/simulate-a-shopping-cart)\n\n[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/create-a-new-cart)\n\n[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/get-cart-information-by-id)\n\n[Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/remove-all-items-from-cart)\n\n[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/update-cart-items)\n\n[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/get-cart-installments-information)\n\n[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/add-coupons-to-the-cart)\n\n[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/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/shopping-cart-section-api-quick-start-guides/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-guides/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-guides/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/simulate-a-shopping-cart)\n\n[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/create-a-new-cart)\n\n[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/get-cart-information-by-id)\n\n[Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/remove-all-items-from-cart)\n\n[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/update-cart-items)\n\n[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/get-cart-installments-information)\n\n[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/add-coupons-to-the-cart)\n\n[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/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/shopping-cart-section-api-quick-start-guides/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-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/shopping-cart-section-api-quick-start-guides/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides/docs/guides/shopping-cart-section-api-quick-start-guides)\n\nShopping Cart\n\nThis section contains the quick start guides of the endpoints described in the [Shopping cart section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23shopping-cart) of the Checkout API Reference.\n\n* [Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/simulate-a-shopping-cart)\n* [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)\n* [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-cart-information-by-id)\n* [Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/remove-all-items-from-cart)\n* [Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/remove-all-personal-data)\n* [Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/add-cart-items)\n* [Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/update-cart-items)\n* [Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/change-price)\n* [Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/ignore-profile-data)\n* [Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-cart-installments-information)\n* [Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/add-coupons-to-the-cart)\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\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/Checkout/shopping-cart-section-api-quick-start-guides.md)\n\n[SSL/TLS Security Protocols and Ciphers at Checkout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides//docs/guides/ssltls-security-protocols-and-ciphers-at-checkout)[Simulate a shopping cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shopping-cart-section-api-quick-start-guides//docs/guides/simulate-a-shopping-cart)\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/shopping-cart-section-api-quick-start-guides.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_65326f18
|
[
{
"role": "system",
"content": "You are a VTEX 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 input 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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-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-search-input-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-search-input-field/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-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-search-input-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-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-search-input-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-search-input-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-search-input-field/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-overview)\n\nSearchInputField\n\nResponsible to receive, search and display suggestions.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/SearchInputField)\n\nAn [InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field) with a search button. 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## Usage\n\n### Import the component\n\n`1\n\nimport { SearchInputField } 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/SearchInputField/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-field-height-mobile | var(--fs-control-tap-size) |\n| \\--fs-search-input-field-height-desktop | var(--fs-spacing-6) |\n| \\--fs-search-input-field-transition-timing | var(--fs-transition-timing) |\n| \\--fs-search-input-field-transition-function | ease |\n\n### Design tokens: Button\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------------------ | ------------------------------------------------------- |\n| \\--fs-search-input-field-button-min-height | var(--fs-search-input-height-desktop) |\n| \\--fs-search-input-field-button-padding-top-desktop | var(--fs-spacing-0) |\n| \\--fs-search-input-field-button-padding-bottom-desktop | var(--fs-search-input-field-button-padding-top-desktop) |\n\n### Design tokens: Input\n\n| Local token | Default value/Global token linked |\n| -------------------------------------------- | ----------------------------------------- |\n| \\--fs-search-input-field-input-padding-right | var(--fs-search-input-field-button-width) |\n| \\--fs-search-input-field-input-bkg-color | var(--fs-color-body-bkg) |\n\n---\n\n## Data attributes\n\nYou can target and override `SearchInputField` styles using the following data attributes:\n\n`data-fs-search-input-field`\n\n`data-fs-search-input-field-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| **buttonProps** | ButtonProps | Props for the submit button inside the input. | | | | | | | | |\n| **buttonIcon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A React component that will be rendered as an icon (submit button). | <Icon name=\"MagnifyingGlass\" /> |\n| **aria-label** | string | Custom aria-label for input and button. | | | | | | | | |\n| **onSubmit\\*** | (value: string) => void | Callback function when submitted. | | | | | | | | |\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/search-input-field.mdx)\n\n[SearchHistory« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-history)[SearchProductsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-products)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23design-tokens)\n\n[Design tokens: Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23design-tokens-button)[Design tokens: Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23design-tokens-input)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-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/search-input-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-search-input-field/docs/guides/faststore/molecules-search-input-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23design-tokens)\n\n[Design tokens: Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23design-tokens-button)[Design tokens: Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23design-tokens-input)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-input-field/docs/guides/faststore/molecules-search-input-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_554b854d
|
[
{
"role": "system",
"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 notification 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/notification/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/notification/docs/api-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/notification/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/notification/docs/storefront-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/notification/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/notification/docs/troubleshooting)\n\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/notification/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/notification/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/notification/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/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/notification/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/notification/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/notification/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/notification/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/notification/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/notification/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/notification/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/notification/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/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/notification/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/notification/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/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/notification/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/notification/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/notification/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/notification/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/notification/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/notification/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/notification/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/notification/docs/vtex-io-apps)\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/guides/store-components)\n\nNotification\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 `notification` component displays text content in a bar style (`notification.bar`) or inline (`notification.inline`). 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 `notification` block to any template of your choice. For example:\n\n`1\n\n \"store.home\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n+ \"notification.bar\", \n\n4\n\n \"carousel#home\", \n\n5\n\n \"shelf#home\" \n\n6\n\n ] \n\n7\n\n }, \n\n`\n\n1. Then, declare the `notification` block using the props stated in the [Props](#props) table.\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| content | String | Text to be used in the bar. | '' |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------------------ |\n| notificationBarContainer |\n| notificationBarInner |\n| notificationContent |\n\n[Logo« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/logo)[Product BrandNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/productbrand)\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/notification/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/notification/docs/apps/vtex.store-components/notification%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/notification%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/notification/docs/apps/vtex.store-components/notification%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_52ac71d2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore developing and overriding components 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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-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/developing-and-overriding-components-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore)\n\nDeveloping and overriding UI components\n\nFastStore offers the ability to extend and customize your store components in the following ways:\n\n## Content customization with Headless CMS\n\nChange the behavior of specific components by changing their props in the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview). In the VTEX Admin, go to **Storefront > Headless CMS** and select the section where the desired component is located. From there, you can customize the component by modifying its props. Find the available props in each native section for customization in the Headless CMS in [list of available native sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections).\n\n> The props changed via Headless CMS overlap the changes made through [override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/building-sections/overriding-components-and-props%23override-native-components-props). For example, if you change a prop through override and also change it using Headless CMS, the final prop's value will be the one added using CMS.\n\n## Theming customization\n\nChange the store theme and component styling using theming and design tokens. For detailed instructions on customizing through these methods, refer to the [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview) and [Styling a Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components) documentation.\n\n## Components and sections customization\n\nYou have the following customization options for components and sections:\n\n| Type of customization | Description |\n| ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [Override native component's props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props) | Modify the behavior of a specific component by passing additional props to it in your store code. |\n| [Override a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-native-component) | Create a new component and override its native equivalent to achieve the desired functionality. |\n| [Create a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) | If the available FastStore native sections do not meet your business requirements, you can create a new section and make it available in the Headless CMS. |\n\n### Considerations for customizing components and sections\n\n### Use for advanced customizations\n\nConsider using overrides when [FastStore design tokens (theming tools)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview%23what-is-theming) or Headless CMS props alone cannot achieve the customization you need. Overrides are suitable for making changes in component behavior or replacing components entirely.\n\n### Manage Analytics\n\nThe [\\_\\_experimentalProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-card) and [SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input) components are FastStore components that need to be customized carefully, since they can affect the triggering of events and impact your [Intelligent Search Analytics](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/analytics--6qRMAHDL9hvv3oE0bh8mA1) store report. To understand how these components can affect store analytics while customizing them, refer to the [List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections).\n\n## API extension\n\nAdd new data to existing queries on the FastStore API by extending it. Refer to the [API extension guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview) for more information.\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/overview.mdx)\n\n[Enabling refresh token on FastStore« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/session-enabling-refresh-token)[Section overrideNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/overrides-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Content customization with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23content-customization-with-headless-cms)\n\n[Theming customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23theming-customization)\n\n[Components and sections customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23components-and-sections-customization)\n\n[Considerations for customizing components and sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23considerations-for-customizing-components-and-sections)[Use for advanced customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23use-for-advanced-customizations)[Manage Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23manage-analytics)\n\n[API extension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23api-extension)\n\nWas this helpful?\n\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/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Content customization with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23content-customization-with-headless-cms)\n\n[Theming customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23theming-customization)\n\n[Components and sections customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23components-and-sections-customization)\n\n[Considerations for customizing components and sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23considerations-for-customizing-components-and-sections)[Use for advanced customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23use-for-advanced-customizations)[Manage Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23manage-analytics)\n\n[API extension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-overview/docs/guides/faststore/developing-and-overriding-components-overview%23api-extension)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_bfb06a2a
|
[
{
"role": "system",
"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 promotions and taxes 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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-api/docs/api-reference/promotions-and-taxes-api/)\n\nCoupons\n\nPromotions and Taxes\n\nPrices (Legacy - v1)\n\nBundles\n\nCampaign Audiences\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-api/docs/api-reference/promotions-and-taxes-api/)\n\nCoupons\n\nPromotions and Taxes\n\nPrices (Legacy - v1)\n\nBundles\n\nCampaign Audiences\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-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/promotions-and-taxes-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PuConfigure External Price Source« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/docs/api-reference/pricing-hub%23put-/api/pricing-hub/prices/config)[PoCreate multiple couponsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/docs/api-reference/promotions-and-taxes-api%23post-/api/rnb/pvt/multiple-coupons)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d9e93c1c
|
[
{
"role": "system",
"content": "You are a VTEX 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 reference implementation in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-reference-implementation/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-reference-implementation/docs/api-reference)\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-reference-implementation/docs/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-reference-implementation/docs/storefront-development)\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-reference-implementation/docs/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-reference-implementation/docs/troubleshooting)\n\n[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-reference-implementation/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/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-reference-implementation/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/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-reference-implementation/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/tax-services-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/tax-services-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/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-reference-implementation/docs/guides/tax-protocol-graphql-api)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/tax-services-reference-implementation)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/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-reference-implementation/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-reference-implementation/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/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-reference-implementation/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-reference-implementation/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/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-reference-implementation/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/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-reference-implementation/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/tax-services-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/tax-services-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/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-reference-implementation/docs/guides/tax-protocol-graphql-api)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/tax-services-reference-implementation)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/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-reference-implementation/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-reference-implementation/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/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-reference-implementation/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-reference-implementation/docs/guides)\n\nIntegration Guides\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/tax-service-integration-guide)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation/docs/guides/tax-services-reference-implementation)\n\nReference Implementations\n\nThis is an example of the implementation described in this [recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-recipe).\n\n| Name | Type | Link |\n| -------------------- | -------- | --------------------------------------------------- |\n| Tax protocol example | Template | <https://github.com/vtex-apps/tax-protocol-example> |\n\n[Back](tax-service-integration-guide)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/tax-service-integration-guide/tax-services-reference-implementation.md)\n\n[Tax Protocol GraphQL API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation//docs/guides/tax-protocol-graphql-api)[Pricing HubNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-reference-implementation//docs/guides/pricing-hub)\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/tax-service-integration-guide/tax-services-reference-implementation.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_4a61d7f6
|
[
{
"role": "system",
"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 btg360 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.btg360/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/api-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.btg360/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.btg360/docs/storefront-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.btg360/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.btg360/docs/troubleshooting)\n\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.btg360/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/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.btg360/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/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.btg360/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.btg360/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/guides/pixel-apps)\n\nBTG360\n\nOfficial extension\n\nVersion: 1.1.0\n\nLatest version: 1.1.0\n\nBTG 360 uses behavioral targert technology so you can achieve even more assertive results with email marketing campaigns based on browsing and / or purchasing behavior of each one of the registered users in your lists.\n\nFor more information please visit, [AllIn](https://read.calvincode.net/reader?url=https://allinmail.com.br/) website.\n\n## How to install\n\nOpen the VTEX App Store and install this app on your store.\n\nNow, open the app settings on your admin and fill in the BTG360 options.\n\nor\n\nRun the following command:\n\n`1\n\nvtex install vtex.btg360@0.x \n\n`\n\n[Blueknow app« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.blueknow)[CookiebotNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.cookiebot)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[How to install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.btg360/docs/apps/vtex.btg360%23how-to-install)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_5ddc39cd
|
[
{
"role": "system",
"content": "You are a VTEX 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 modal 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-modal-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-modal-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-modal-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-modal-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-modal-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-modal-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-modal-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-modal-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-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-modal-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-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-modal-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-modal-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-modal-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-modal-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-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-modal-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-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-modal-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-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-modal-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-modal-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-modal-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-modal-layout/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/layout-apps)\n\nModal Layout\n\nOfficial extension\n\nVersion: 0.14.2\n\nLatest version: 0.14.2\n\n[](#contributors-)\n\nThe Modal Layout app provides blocks to help you create modals in your store.\n\n\n\n## Configuration\n\n1. Add the Modal Layout app to your theme dependencies in the `manifest.json`:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.modal-layout\": \"0.x\" \n\n3\n\n } \n\n`\n\nNow, you can use all blocks exported by the `modal-layout` app. See the full list below:\n\n| Block name | Description |\n| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| modal-trigger |  Defines how the modal content will be triggered through its children blocks. |\n| modal-layout |  Defines how the modal content will be rendered through its children blocks. You can declare the modal-header and modal-content blocks, described below, as children to create a modal with a header and footer. |\n| modal-header | Renders a close button and the blocks listed as its children, building a modal header. Note that it does not automatically render a header for your modal. Instead, you should create the modal header as you desire using the children list of this block. |\n| modal-content | Defines how the modal content will be rendered through its children blocks. Preferably, this block should be used along with the modal-header block in order to create a modal with a header and a footer. |\n| modal-actions | Logical block that only renders its child blocks that, in turn, render call-to-action buttons inside the modal, such as a confirmation button. |\n| modal-actions.close | Button that closes the modal when clicked. It is extremely useful when your modal only has a form or a disclaimer box providing information to the users. |\n\n1. Add the `modal-trigger` block in any store template you choose. In the example below, it will be added to the homepage:\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"modal-trigger#example\" \n\n5\n\n ] \n\n6\n\n }, \n\n`\n\n1. Declare the `modal-trigger` block using its prop and configure the children blocks. The first child block of `modal-trigger` must be a block you choose to trigger the modal content. Then, a sibling block called `modal-layout` will be needed to effectively define the modal content through its child block list. For example:\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"children\": [\"modal-trigger#example\"] \n\n4\n\n }, \n\n5\n\n \"modal-trigger#example\": { \n\n6\n\n \"children\": [\"rich-text#example\", \"modal-layout#example\"] \n\n7\n\n }, \n\n8\n\n \"rich-text#example\": { \n\n9\n\n \"props\": { \n\n10\n\n \"text\": \"Click me\" \n\n11\n\n } \n\n12\n\n }, \n\n13\n\n \"modal-layout#example\": { \n\n14\n\n \"children\": [\"rich-text#modal-content\"] \n\n15\n\n }, \n\n16\n\n \"rich-text#modal-content\": { \n\n17\n\n \"props\": { \n\n18\n\n \"text\": \"Hello\" \n\n19\n\n } \n\n20\n\n } \n\n21\n\n} \n\n`\n\nIn the example above, the [Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/) block renders the `Click me` text that will trigger the modal content when clicked. The modal content, in turn, is defined by the `modal-layout` block. Based on the example above, the modal content triggered by the `Click me` Rich Text would be a `Hello` text.\n\n### `modal-trigger` props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| trigger | enum | Defines whether the modal content should be triggered by user click (click), when the page is fully loaded (load), or when the page is fully loaded, but the modal will appear just once per session (load-session). | click |\n| customPixelEventId | string | Store event ID that triggers the modal-trigger block (hence triggering the opening of modal-layout blocks on the interface as well). | undefined |\n| customPixelEventName | string | Store event name that triggers the modal-trigger block (hence triggering the opening of modal-layout blocks on the interface as well). Some event examples are 'addToCart' and 'removeFromCart'. Note that using this prop will make the associated modal-layout open in **every** event with the specified name if no customPixelEventId is set. | undefined |\n\n### `modal-layout` props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| scroll | enum | Defines how users should scroll the modal. Possible values are: body (users can scroll the whole modal by normally scrolling the page) and content (users can scroll the modal _content_ when hovering over it). | content |\n| blockClass | string | Unique block ID 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). | undefined |\n| disableEscapeKeyDown | boolean | Defines whether the modal should be closed when pressing the Esc key (true) or not (false). | false |\n| fullScreen | boolean | Defines whether the modal should fill the whole screen (true) or not (false). This prop is responsive, i.e., it adapts to the device breakpoints. | false |\n| backdrop | enum | Defines whether the modal will have a clickable backdrop (clickable) or no backdrop at all (none). This prop is responsive, i.e., it adapts to the device breakpoints. | clickable |\n| customPixelEventId | string | Store event ID that triggers the modal-layout block (hence triggering the closing of modal-layout blocks on the interface as well). | undefined |\n| customPixelEventName | string | Store event name that triggers the modal-layout block (hence triggering the closing of modal-layout blocks on the interface as well). Some event examples are 'addToCart' and 'removeFromCart'. Note that using this prop will make the associated modal-layout close in **every** event with the specified name if no customPixelEventId is set. | undefined |\n\n### `modal-header` props\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------- | --------------------------------------------------------------------------------------------------- | ------------- |\n| showCloseButton | boolean | Defines whether the close icon button should be rendered in the modal header (true) or not (false). | true |\n| iconCloseSize | number | Size (in pixels) of the close icon button in the modal header. | 32 |\n\n### `modal-actions.close` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |\n| label | string | Defines the text to be rendered in the close button. The default value of this prop depends on the store's default language, which is set according to the website [binding](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-binding--4NcN3NJd0IeYccgWCI8O2W?locale=en). | Cancel, Cancelar, or Cancelar for stores whose default language is, respectively, English, Spanish, or Portuguese. |\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| modal |\n| backdropContainer |\n| backdrop |\n| closeButtonContainer |\n| closeButton |\n| container |\n| contentContainer |\n| headerContainer |\n| headerContent |\n| paper |\n| topRow |\n| triggerContainer |\n\n[Flex Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.flex-layout)[Overlay LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.overlay-layout)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%23configuration)\n\n[modal-trigger props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%23modal-trigger-props)[modal-layout props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%23modal-layout-props)[modal-header props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%23modal-header-props)[modal-actions.close props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%23modal-actionsclose-props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-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_e9bc3328
|
[
{
"role": "system",
"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 headless cms 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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-api/docs/api-reference/headless-cms-api/)\n\nPages\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-api/docs/api-reference/headless-cms-api/)\n\nPages\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-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/headless-cms-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeList All GiftCard Transactions Settlements« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/giftcard-hub-api%23get-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-/transactions/-tId-/settlements)[GeGet all content typesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/headless-cms-api%23get-/%5Fv/cms/api/-projectId-)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0965a7a4
|
[
{
"role": "system",
"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 4.0.1 b2bquotes graphql api app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-checkout-settings)\n\n[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-orders-history)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)\n\n[B2B Quotes GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-checkout-settings)\n\n[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-orders-history)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)\n\n[B2B Quotes GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/vtex-io-apps)\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-suite)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)\n\nB2B Quotes GraphQL API\n\n[vtex.b2b-quotes-graphql](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql)\n\nVersion: 4.0.1\n\nLatest version: 4.0.1\n\nThis article provides a reference guide to the B2B Quotes GraphQL API, with details about the available queries and mutations for the [B2B Quotes app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes). The API supports quote management and related configurations in a B2B environment, enabling users to retrieve, create, and update quotes, as well as manage application settings and permissions.\n\n## Schema overview\n\n### Query\n\nadminSetup\n\ngetAppSettings\n\nupdateHistory\n\nitems\n\ngetQuote\n\ndata\n\npagination\n\ngetQuotes\n\ngetChildrenQuotes\n\nAdminSetup\n\ncartLifeSpan Int\n\nquotesManagedBy QuotesManagedBy!\n\nAppSettings\n\nadminSetup AdminSetup\n\nQuoteUpdate\n\nemail String\n\nrole String\n\ndate String\n\nstatus String\n\nnote String\n\nQuoteItem\n\nname String\n\nskuName String\n\nrefId String\n\nid String\n\nproductId String\n\nimageUrl String\n\nlistPrice Float\n\nprice Float\n\nquantity Int\n\nsellingPrice Float\n\nseller String\n\nQuote\n\nid String\n\nreferenceName String\n\ncreatorEmail String\n\ncreatorRole String\n\ncreationDate String\n\nexpirationDate String\n\nlastUpdate String\n\nupdateHistory \\[QuoteUpdate\\]\n\nitems \\[QuoteItem\\]\n\nsubtotal Float\n\nstatus String\n\norganization String\n\norganizationName String\n\ncostCenter String\n\ncostCenterName String\n\nviewedBySales Boolean\n\nviewedByCustomer Boolean\n\nsalesChannel String\n\nseller String\n\nparentQuote String\n\nhasChildren Boolean\n\nPagination\n\npage Int\n\npageSize Int\n\ntotal Int\n\nQuotes\n\ndata \\[Quote\\]\n\npagination Pagination\n\nQuery\n\ngetAppSettings AppSettings\n\ngetQuoteEnabledForUser(email String!) : Boolean\n\ngetQuote(id String) : Quote\n\ngetQuotes(organization \\[String\\], costCenter \\[String\\], status \\[String\\], search String, page Int, pageSize Int, sortOrder String, sortedBy String) : Quotes\n\ngetChildrenQuotes(id String, page Int, pageSize Int, sortOrder String, sortedBy String) : Quotes\n\n| Field | Argument | Type | Description |\n| -------------------------- | --------------------------- | --------------------------------------------------------------------------- | ----------- |\n| **getAppSettings** | [AppSettings](#appsettings) | Retrieves the current configuration settings of the B2B Quotes app. | |\n| **getQuoteEnabledForUser** | Boolean | Checks if the specified user has permission to use the quotes feature. | |\n| email | String! | Email address of the user to check permissions for. | |\n| **getQuote** | [Quote](#quote) | Retrieves a specific quote by ID. | |\n| id | String | Unique identifier of the quote to retrieve. | |\n| **getQuotes** | [Quotes](#quotes) | Retrieves a paginated list of quotes and saved carts with optional filters. | |\n| organization | \\[String\\] | Filters quotes and saved carts by organization IDs. | |\n| costCenter | \\[String\\] | Filters quotes and saved carts by cost center IDs. | |\n| status | \\[String\\] | Filters by status: READY, PENDING, REVISED, DECLINED, EXPIRED, or PLACED. | |\n| search | String | Searches quotes and saved carts by reference name. | |\n| page | Int | Page number for pagination. | |\n| pageSize | Int | Number of quotes per page. | |\n| sortOrder | String | Specifies the sort direction (ASC or DESC). | |\n| sortedBy | String | Field to sort the quotes by. | |\n| **getChildrenQuotes** | [Quotes](#quotes) | Retrieves child quotes associated with a parent quote. | |\n| id | String | ID of the parent quote. | |\n| page | Int | Page number for pagination. | |\n| pageSize | Int | Number of child quotes per page. | |\n| sortOrder | String | Specifies the sort direction (ASC or DESC). | |\n| sortedBy | String | Field to sort the child quotes by. | |\n\n### Mutation\n\nadminSetup\n\nsaveAppSettings\n\nAdminSetup\n\ncartLifeSpan Int\n\nquotesManagedBy QuotesManagedBy!\n\nAppSettings\n\nadminSetup AdminSetup\n\nMutation\n\ncreateQuote(input QuoteInput!) : String\n\nupdateQuote(input QuoteUpdateInput!) : String\n\nuseQuote(id String, orderFormId String) : String\n\nclearCart(orderFormId String) : String\n\nsaveAppSettings(input AppSettingsInput!) : AppSettings\n\n| Field | Argument | Type | Description |\n| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------- |\n| **createQuote** | String | Creates a new quote (PENDING status) or saved cart (READY status) from the current shopping cart. | |\n| input | [QuoteInput](#quoteinput)! | Input data for creating a new quote. | |\n| **updateQuote** | String | Updates an existing quote or saved cart, including price adjustments, quantities, and status changes. | |\n| input | [QuoteUpdateInput](#quoteupdateinput)! | Input data for updating the quote. | |\n| **useQuote** | String | Applies a quote or saved cart to the current shopping cart and redirects to checkout. | |\n| id | String | ID of the quote to be applied. | |\n| orderFormId | String | ID of the order form to apply the quote to. | |\n| **clearCart** | String | Removes all items from the current shopping cart before applying a quote. | |\n| orderFormId | String | ID of the order form to be cleared. | |\n| **saveAppSettings** | [AppSettings](#appsettings) | Updates the B2B Quotes app settings. | |\n| input | [AppSettingsInput](#appsettingsinput)! | New configuration to be saved. | |\n\n## Schema description\n\n> Arguments must be provided by the user. Required fields are marked with an exclamation mark (`!`).\n\n### AppSettings\n\n| Field | Type | Description |\n| -------------- | ------------------------- | ------------------------------------------------ |\n| **adminSetup** | [AdminSetup](#adminsetup) | Configuration settings for the B2B Quotes admin. |\n\n[Query](#query) 🔼\n\n[Mutation](#mutation) 🔼\n\n### AppSettingsInput\n\n| Field | Type | Description |\n| ------------------- | ----------------------------------- | ----------------------------------------------------------------------------------------- |\n| **cartLifeSpan** | Int | Default expiration period in days for quotes and saved carts. The minimum value is 1 day. |\n| **quotesManagedBy** | [QuotesManagedBy](#quotesmanagedby) | Defines who has permission to manage quotes (marketplace admins or individual sellers). |\n\n[Mutation](#mutation) 🔼\n\n### AdminSetup\n\n| Field | Type | Description |\n| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------- |\n| **cartLifeSpan** | Int | Default expiration period in days for quotes and saved carts. The minimum value is 1 day. |\n| **quotesManagedBy** | [QuotesManagedBy](#quotesmanagedby)! | Defines who has permission to manage quotes (marketplace administrators or individual sellers). |\n\n[AppSettings](#appsettings) 🔼\n\n### Quotes\n\n| Field | Type | Description |\n| -------------- | ------------------------- | ---------------------------------------------- |\n| **data** | \\[[Quote](#quote)\\] | Array of quotes matching the query parameters. |\n| **pagination** | [Pagination](#pagination) | Pagination details for the quotes list. |\n\n[Query](#query) 🔼\n\n### Quote\n\n| Field | Type | Description |\n| -------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **id** | String | Unique identifier for the quote. |\n| **referenceName** | String | User-defined name to identify the quote or saved cart. |\n| **creatorEmail** | String | Email address of the user who created the quote. |\n| **creatorRole** | String | Role of the user who created the quote. |\n| **creationDate** | String | Date and time when the quote was created. |\n| **expirationDate** | String | Date and time when the quote will expire. |\n| **lastUpdate** | String | Date of the last time when the quote or saved cart was updated. |\n| **updateHistory** | \\[[QuoteUpdate](#quoteupdate)\\] | History of all events related to the quote, including creation, discounts, and notes. |\n| **items** | \\[[QuoteItem](#quoteitem)\\] | Products included in the quote. |\n| **subtotal** | Float | Total price of all items, including any discounts offered by sales associates. |\n| **status** | String | Current status of the quote. Possible values are:READY (ready to place the order)PENDING (waiting for review)REVISED (waiting for additional review)DECLINED (can't be used)EXPIRED (past expiration date)PLACED (already used) |\n| **organization** | String | ID of the organization the quote belongs to. |\n| **organizationName** | String | Name of the organization the quote belongs to. |\n| **costCenter** | String | ID of the cost center associated with the quote. |\n| **costCenterName** | String | Name of the cost center associated with the quote. |\n| **viewedBySales** | Boolean | Indicates if a sales associate has viewed the quote or saved cart. |\n| **viewedByCustomer** | Boolean | Indicates if the customer has viewed the quote or saved cart. |\n| **salesChannel** | String | Sales channel associated with the quote or saved cart. |\n| **seller** | String | ID of the seller associated with the quote. |\n| **parentQuote** | String | ID of the parent quote if this is a child quote. |\n| **hasChildren** | Boolean | Indicates if this quote has associated child quotes. |\n\n[Query](#query) 🔼\n\n[Quotes](#quotes) 🔼\n\n### QuoteInput\n\n| Field | Type | Description |\n| ------------------ | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| **referenceName** | String | User-defined name to identify the quote. |\n| **items** | \\[[QuoteItemInput](#quoteiteminput)\\] | List of products to include in the quote. |\n| **subtotal** | Float | Total price of all items, including any discounts offered by sales associates. |\n| **note** | String | Optional note that will be visible in the quote's update history to salespeople and organization members. |\n| **sendToSalesRep** | Boolean | If true, creates a quote with PENDING status for sales review. If false, creates a saved cart with READY status. |\n\n[Mutation](#mutation) 🔼\n\n### QuoteUpdate\n\n| Field | Type | Description |\n| ---------- | ------ | ------------------------------------------------------------------------------------- |\n| **email** | String | Email of the user who made the update. |\n| **role** | String | Role of the user who made the update (such as sales associate or organization buyer). |\n| **date** | String | Date when the update was made. |\n| **status** | String | Status change made in this update, if any. |\n| **note** | String | Optional comment or instruction added during this update. |\n\n[Quote](#quote) 🔼\n\n### QuoteItem\n\n| Field | Type | Description |\n| ---------------- | ------ | ------------------------------------------------------------------ |\n| **name** | String | Product name. |\n| **skuName** | String | Name of the specific SKU variant. |\n| **refId** | String | Reference ID of the product. |\n| **imageUrl** | String | URL of the product image. |\n| **listPrice** | Float | Original price before any discounts. |\n| **price** | Float | Original product price before any discounts. |\n| **quantity** | Int | Number of items. |\n| **sellingPrice** | Float | Product price including any discounts offered by sales associates. |\n\n[Quote](#quote) 🔼\n\n### QuoteUpdateInput\n\n| Field | Type | Description |\n| ------------------ | ------------------------------------- | ------------------------------------------------------------------------------------- |\n| **id** | String | Unique identifier of the quote to be updated. |\n| **items** | \\[[QuoteItemInput](#quoteiteminput)\\] | Updated list of products with their quantities and prices. |\n| **subtotal** | Float | Updated total price of all items. |\n| **note** | String | Optional comment or instruction that will be displayed in the quote's update history. |\n| **decline** | Boolean | When true, changes the quote status to DECLINED, preventing further use. |\n| **expirationDate** | String | New expiration date for the quote or saved cart. |\n\n[Mutation](#mutation) 🔼\n\n### QuoteItemInput\n\n| Field | Type | Description |\n| ---------------- | ------ | ------------------------------------------------------------------ |\n| **name** | String | Product name. |\n| **skuName** | String | Name of the specific SKU variant. |\n| **refId** | String | Reference ID of the product. |\n| **id** | String | Unique identifier for the SKU. |\n| **productId** | String | Unique identifier for the product. |\n| **imageUrl** | String | URL of the product image. |\n| **listPrice** | Float | Original price before any discounts. |\n| **price** | Float | Original product price before any discounts. |\n| **quantity** | Int | Number of items. |\n| **sellingPrice** | Float | Product price including any discounts offered by sales associates. |\n| **seller** | String | ID of the seller offering this item. |\n\n[QuoteUpdateInput](#quoteupdateinput) 🔼\n\n### Pagination\n\n| Field | Type | Description |\n| ------------ | ---- | --------------------------------------- |\n| **page** | Int | Current page number. |\n| **pageSize** | Int | Number of items per page. |\n| **total** | Int | Total number of items across all pages. |\n\n[Quotes](#quotes) 🔼\n\n## Enums\n\n### QuotesManagedBy\n\n| Field | Description |\n| --------------- | --------------------------------------------- |\n| **MARKETPLACE** | Quotes are managed by the marketplace admins. |\n| **SELLER** | Quotes are managed by individual sellers. |\n\n[AppSettingsInput](#appsettingsinput) 🔼\n\n[AdminSetup](#adminsetup) 🔼\n\n[B2B Quotes & Carts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)[Functional AppsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/functional-apps)\n\nSee also\n\n[Vtex.b2b Quotes GraphqlVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23schema-description)\n\n[AppSettings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23appsettings)[AppSettingsInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23appsettingsinput)[AdminSetup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23adminsetup)[Quotes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quotes)[Quote](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quote)[QuoteInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quoteinput)[QuoteUpdate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quoteupdate)[QuoteItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quoteitem)[QuoteUpdateInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quoteupdateinput)[QuoteItemInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quoteiteminput)[Pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23pagination)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23enums)\n\n[QuotesManagedBy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quotesmanagedby)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b9679a44
|
[
{
"role": "system",
"content": "You are a VTEX 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 region for skus in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/features)\n\n[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/docs/guides/configure-the-global-checkout)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/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-region-for-skus/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/features)\n\n[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/docs/guides/configure-the-global-checkout)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/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-region-for-skus/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/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-region-for-skus/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-region-for-skus/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/checkout-api-overview)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/features)\n\n[Enable the Region for SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus/docs/guides/enable-the-region-for-skus)\n\nEnable the Region for SKUs\n\nThe Region feature is one of the features made available by the session system installation. It aims to regionalize user experience of the store. It allows, for example, for sellers to set their own prices and that the marketplaces display them according to the client’s region.\n\nAfter you [set up delivery](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-price-and-availability-of-skus-by-region--12ne58BmvYsYuGsimmugoc%23setting-up-delivery-in-franchise-accountseller-white-label) of a SKU to a White Label Seller from your store, it is necessary for the session system to identify the zip code and country of the user browsing the store to show the custom price and availability by region.\n\nThis information about ZIP code and country can be stored in the cookie [vtex\\_session](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-price-and-availability-of-skus-by-region--12ne58BmvYsYuGsimmugoc), due to a purchase made previously by the user, or can be entered via JavaScript in the session.\n\nTo enter the country and zip code in the session, you must perform a `POST` in the following route:`{{account-name}}.{{environment}}.com.br/api/sessions`\n\nBelow are examples of bodies to be sent to `POST`:\n\n* Update session by postal code.\n\n`1\n\n{ \n\n2\n\n \"public\": { \n\n3\n\n \"country\": { \n\n4\n\n \"value\": \"USA\" \n\n5\n\n }, \n\n6\n\n \"postalCode\": { \n\n7\n\n \"value\": \"32004\" \n\n8\n\n } \n\n9\n\n } \n\n10\n\n} \n\n`\n\n* Update session by geo-coordinates.\n\n`1\n\n{ \n\n2\n\n \"public\": { \n\n3\n\n \"country\": { \n\n4\n\n \"value\": \"USA\" \n\n5\n\n }, \n\n6\n\n \"geoCoordinates\": { \n\n7\n\n \"value\": \"22.123,-14.1\" \n\n8\n\n } \n\n9\n\n } \n\n10\n\n} \n\n`\n\n* Update session by address.\n\n`1\n\n{ \n\n2\n\n \"public\": { \n\n3\n\n \"storeUserEmail\": { \n\n4\n\n \"value\": \"<mailto:example@example.complexample.com>\" \n\n5\n\n }, \n\n6\n\n \"addressId\": { \n\n7\n\n \"value\": \"123456789\" \n\n8\n\n } \n\n9\n\n } \n\n10\n\n} \n\n`\n\nTo verify that the session has updated the country and zip code data, send a `GET` request on the route below and search for the `country` and `postalCode` fields:`{{account-name}}.{{environment}}.com.br/api/sessions?items={{namespace}}.{{value}},{{namespace}}.{{value2}}`\n\nAfter refreshing the product page, the platform will update price and availability information according to the region specified in the country and zip code information.\n\nContributors\n\n2\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/features/enable-the-region-for-skus.md)\n\n[Enable the Save user data opt-in« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus//docs/guides/enable-the-save-user-data-opt-in)[Configure the Global CheckoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus//docs/guides/configure-the-global-checkout)\n\nContributors\n\n2\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/features/enable-the-region-for-skus.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_58261a9a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides extracting data from master data with search and scroll in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/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/extracting-data-from-master-data-with-search-and-scroll/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/master-data-best-practices)\n\n[Extracting data from Master Data with search and scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll)\n\n[Pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/pagination-in-the-master-data-api)\n\n[Avoiding CORS in Master Data requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/avoiding-cors-in-master-data-requests)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/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/extracting-data-from-master-data-with-search-and-scroll/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/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/extracting-data-from-master-data-with-search-and-scroll/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/extracting-data-from-master-data-with-search-and-scroll/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/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/extracting-data-from-master-data-with-search-and-scroll/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/master-data-best-practices)\n\n[Extracting data from Master Data with search and scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll)\n\n[Pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/pagination-in-the-master-data-api)\n\n[Avoiding CORS in Master Data requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/avoiding-cors-in-master-data-requests)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/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/extracting-data-from-master-data-with-search-and-scroll/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/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/extracting-data-from-master-data-with-search-and-scroll/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/extracting-data-from-master-data-with-search-and-scroll/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/master-data-best-practices)\n\n[Extracting data from Master Data with search and scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll)\n\nExtracting data from Master Data with search and scroll\n\nLearn how to extract data from Master Data using the search and scroll endpoints and best practices for optimizing queries and handling large datasets.\n\nIn this guide, you will learn how to extract data from Master Data using the search and scroll endpoints, including when to use each route, how to optimize queries, and best practices.\n\n> In Master Data v1, you can export data directly from the interface. See [Exporting data from Master Data v1](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/exporting-data--tutorials%5F1125) for more information.\n\n## Search\n\nThe search route is ideal when you need to find a specific set of documents within your store. It is particularly useful for paginated queries, where you want to retrieve up to 10,000 documents in small chunks over multiple requests and each page is limited to 100 documents.\n\n> When paginating, the `_sort` parameter is recommended. The API does not guarantee a specific order by default. Therefore, omitting the `_sort` parameter may lead to duplicate documents or return unexpected pages.\n\nCheck the search endpoint reference for your Master Data version:\n\n* [Master Data API v1 - Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search)\n* [Master Data API v2 - Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/search)\n\n### Best practices\n\nWhen using the search endpoint, these best practices will help optimize your data retrieval process:\n\n* **Apply filters to narrow your search**: Improve performance by reducing the number of documents returned. This speeds up the query and ensures that your requests are more efficient.\n* **Use exact values for queries instead of wildcards (`*`):** Heavy usage of wildcards may be subject to temporary blocks.\n* **Avoid large datasets:** If you are querying many documents, break your query into smaller intervals.\n\n> Learn more about [Search pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api%23search-pagination).\n\n## Scroll\n\nThe scroll route is designed for extensive data retrieval, especially when integrating Master Data with external systems. It is the best choice if you need to query the entire database or deal with over 10,000 documents.\n\nCheck the scroll endpoint reference for your Master Data version:\n\n* [Master Data API v1 - Scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/scroll)\n* [Master Data API v2 - Scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/scroll)\n\nYour first scroll request will return a token in the `X-VTEX-MD-TOKEN` response header. Submit this value in the `_token` query parameter for your next requests until you receive an empty list, which indicates that all documents have been retrieved.\n\n> Learn more about [Scroll pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api%23scroll-pagination).\n\n### Scroll best practices\n\nTo ensure efficient and reliable data retrieval, follow these strategies when using the scroll endpoint:\n\n* **Implement filters to divide the request into smaller batches:** This reduces the likelihood of timeouts. For example, you might filter by created date and process data month by month. Smaller batches are also easier to reprocess if a timeout occurs, making your operation more resilient.\n* **Run up to 10 scrolls simultaneously per account:** Limiting the number of parallel scrolls helps prevent errors and timeouts. By using filters to create smaller batches and parallelizing these batches in a controlled manner, you can speed up data retrieval while reducing the risk of overloading the account.\n\n> **Scroll behavior and limitations**\n> \n> * **Each scroll operation allows only one query for the duration of the token.** This means that you cannot change a scroll’s query by changing parameters after the first request. You can navigate pages of the original first request until the token expires, or initiate other scrolls (up to 10 simultaneously).\n> * If Master Data stops receiving requests with the scroll `X-VTEX-MD-TOKEN` token, it will expire in **20 minutes**. After that, you can make new scroll requests, limited to 10 simultaneous scrolls.\n> * The maximum number of documents per scroll request is **1,000**.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-best-practices/extracting-data-from-master-data-with-search-and-scroll.md)\n\n[Master Data best practices« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll//docs/guides/master-data-best-practices)[Pagination in the Master Data APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll//docs/guides/pagination-in-the-master-data-api)\n\nSee also\n\n[Pagination in the Master Data APIGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/pagination-in-the-master-data-api)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll%23search)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll%23best-practices)\n\n[Scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll%23scroll)\n\n[Scroll best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll%23scroll-best-practices)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-best-practices/extracting-data-from-master-data-with-search-and-scroll.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll%23search)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll%23best-practices)\n\n[Scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll%23scroll)\n\n[Scroll best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll/docs/guides/extracting-data-from-master-data-with-search-and-scroll%23scroll-best-practices)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_963b5305
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation store theme in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/updates/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-store-theme/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-store-theme/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/store-framework-managing-performance)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/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-store-theme/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-store-theme/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-store-theme/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/updates/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-store-theme/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-store-theme/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/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-store-theme/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/store-framework-managing-performance)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/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-store-theme/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-store-theme/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-store-theme/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme)\n\nStore Theme\n\nIn [Store Framerwork](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework), a Store Theme is a storefront template that shapes your store's appearance and functionality. It determines how each element of your store will appear on the storefront.\n\n## Project structure\n\nAlthough the structure of a Store Theme project may vary depending on its specific settings, it typically includes the following files and folders:\n\n`1\n\n📂 STORE-THEME/ \n\n2\n\n│ \n\n3\n\n├── 📂 .github/ \n\n4\n\n├── 📂 public/ \n\n5\n\n├── 📂 store/ \n\n6\n\n│ ├── 📂 blocks/ \n\n7\n\n│ ├── 📄 blocks.jsonc \n\n8\n\n│ └── 📄 routes.json \n\n9\n\n├── 📂 styles/ \n\n10\n\n│ ├── 📂 configs/ \n\n11\n\n│ └── 📂 css/ \n\n12\n\n├── 📄 .editorconfig \n\n13\n\n├── 📄 .gitignore \n\n14\n\n├── 📄 .vtexignore \n\n15\n\n├── 📄 CHANGELOG.md \n\n16\n\n├── 📄 manifest.json \n\n17\n\n├── 📄 package-lock.json \n\n18\n\n└── 📄 README.md \n\n`\n\nSome of these files and folders are essential for the theme to function properly:\n\n* **`/store` folder:** Contains the blocks, interfaces, and routes necessary to build the storefront.\n* **`/styles` folder:** Contains the store’s visual elements, such as colors, typography, and other style-related settings.\n* **`manifest.json` file:** Contains the metadata about the app, including vendor, name, version, [dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-dependencies/), and [builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/).\n\n> You must have at least the `store` and `styles` builders configured within the `manifest.json` file for your project to work properly.\n\nStore Themes are [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-what-is-vtex-io) apps that inherently use the [store builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder). This builder allows you to link routes to templates, which are composed of a series of other reusable [components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components) and layout [blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition), contained in the `/store` folder.\n\nTo export the CSS configurations contained in the `/styles` folder for your Store Framework blocks, Store Themes leverage the [styles builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder). This builder helps set a cohesive style for all components in your Store Theme app.\n\nFor more information about available builders, check this [List of Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders%23list-of-builders).\n\n## Development tools\n\nThe VTEX IO platform facilitates the development of Store Themes by providing tools such as [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) and [workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) for developers, as well as content management with [Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor) for business users.\n\nStore Themes can be customized by adding native [VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps) or developing [custom React components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io) to meet business needs and enhance user experience.\n\nBelow are some available themes to get started:\n\n* [Minimum Boilerplate Theme](#minimum-boilerplate-theme)\n* [Store Theme](#store-theme)\n\n## Available themes\n\n### Minimum Boilerplate Theme\n\nThe [Minimum Boilerplate Theme](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minimum-boilerplate-theme) serves as a basic starting point for developers to create new storefronts on the VTEX IO platform. It offers a basic and functional structure that can be customized and expanded based on the specific needs of the project.\n\nThe Minimum Boilerplate Theme should be used only when you want to start a new store theme without any pre-set configurations, as is the case with the [Store Theme](#store-theme).\n\n> Learn how to set this boilerplate in the [Minimum Boilerplate Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme) documentation.\n\n### Store Theme\n\nThe [**Store Theme**](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme) is a boilerplate with pre-set configurations to create a store using [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-what-is-vtex-io).\n\n\n\nThis boilerplate gives you a ready-to-go default storefront structure, including:\n\n* **Pre-configured layouts:** A variety of files organized in different folders within the `/store/blocks` folder. These files combine our native [components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components) to create templates for different parts of the store, such as the homepage, product details page, and order-placed page.\n* **Default styles:** A customizable set of styles that helps you achieve a professional look and feel without extensive custom styling.\n* **Sitemap:** An example of a [Sitemap](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme/blob/master/sitemap/sitemap.json) use case.\n\n> Learn how to start a project with this boilerplate in the [Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) section.\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-store-theme.md)\n\n[Store Framework« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme//docs/guides/store-framework)[Getting startedNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme//docs/guides/getting-started-3)\n\nSee also\n\n[Vtex.store SitemapApps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/apps/vtex.store-sitemap)[ManifestApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-manifest)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme%23project-structure)\n\n[Development tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme%23development-tools)\n\n[Available themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme%23available-themes)\n\n[Minimum Boilerplate Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme%23minimum-boilerplate-theme)[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme%23store-theme)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-store-theme.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme%23project-structure)\n\n[Development tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme%23development-tools)\n\n[Available themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme%23available-themes)\n\n[Minimum Boilerplate Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme%23minimum-boilerplate-theme)[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme/docs/guides/vtex-io-documentation-store-theme%23store-theme)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_51e9c83d
|
[
{
"role": "system",
"content": "You are a VTEX 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 product price in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/updates/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-product-price/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-product-price/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/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-product-price/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/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-product-price/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/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-product-price/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-product-price/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-product-price/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-product-price/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/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-product-price/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-product-price/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/updates/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-product-price/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-product-price/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/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-product-price/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/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-product-price/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/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-product-price/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-product-price/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-product-price/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-product-price/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/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-product-price/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-product-price/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-product-price/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-overview)\n\nProductPrice\n\nDisplays the product's listing and spot price.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/ProductPrice)\n\nThe `ProductPrice` component displays both the listing price and spot price of a product. It wraps two [Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-price) components. The `ProductPrice` component wraps two instances of the `Price` component, representing the prices with the spot and listing variants.\n\n* If the spot price and listing price are the same, only the spot price is shown.\n* If the listing price is set to `0`, only the spot price is shown.\n\nExample\n\nCode\n\nOriginal price:$999Price:$950.04\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { ProductPrice } 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/ProductPrice/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\nOriginal price:$999Price:$950.04\n\n### Example of price formatter function\n\n`1\n\n// Example of formatter \n\n2\n\ninterface PriceFormatterOptions { \n\n3\n\n decimals?: boolean; \n\n4\n\n} \n\n5\n\n \n6\n\nexport const usePriceFormatter = ({ decimals }: PriceFormatterOptions = {}) => { \n\n7\n\n return useCallback( \n\n8\n\n (price: number) => \n\n9\n\n Intl.NumberFormat(\"en-US\", { \n\n10\n\n style: \"currency\", \n\n11\n\n currency: \"USD\", \n\n12\n\n minimumFractionDigits: decimals ? 2 : 0, \n\n13\n\n }).format(price), \n\n14\n\n [decimals] \n\n15\n\n ); \n\n16\n\n}; \n\n17\n\n \n18\n\nexport const useFormattedPrice = (price: number) => { \n\n19\n\n const formatter = usePriceFormatter(); \n\n20\n\n \n21\n\n return useMemo(() => formatter(price), [formatter, price]); \n\n22\n\n}; \n\n`\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ----------------------- | --------------------------------- |\n| \\--fs-product-price-gap | var(--fs-spacing-1) |\n\n---\n\n## Data attributes\n\nYou can target and override `ProductPrice` styles using the following data attributes:\n\n`data-fs-product-price`\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| --------------- | -------------- | -------------------------------------------------------------------------------------- | ---------------- |\n| **value\\*** | number | Specifies product's raw price value. | |\n| **listPrice\\*** | number | Specifies product's listing price. | |\n| **formatter** | PriceFormatter | Formatter function that transforms the raw price value and render the result. | |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing-library, and jest). | fs-product-price |\n\n---\n\n## Related components\n\n* 62.5 \nPrice \nPrices are used to display the price of a given product, discount and total values. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-price)\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/product-price.mdx)\n\n[ProductCard« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-card)[ProductTitleNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-title)\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-product-price/docs/guides/faststore/molecules-product-price%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23examples)\n\n[Example of price formatter function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23example-of-price-formatter-function)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23props)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%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/product-price.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-product-price/docs/guides/faststore/molecules-product-price%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23examples)\n\n[Example of price formatter function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23example-of-price-formatter-function)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%23props)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-price/docs/guides/faststore/molecules-product-price%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_2259ba65
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides displaying sla by item in 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/displaying-sla-by-item-in-checkout/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-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/displaying-sla-by-item-in-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/displaying-sla-by-item-in-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/displaying-sla-by-item-in-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/displaying-sla-by-item-in-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/displaying-sla-by-item-in-checkout/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/updates/release-notes)\n\nDisplaying SLA by item in Checkout\n\nThis guide describes how to display individual shipping estimates for items in a customer's cart on an ecommerce platform using the Checkout API.\n\nTo enhance the customer experience, some stores may want to display precise shipping estimates for each item in the customer's cart. This can be particularly useful for ecommerce platforms that have sellers with different shipping capabilities and delivery times. This guide will walk through the process of displaying the Service Level Agreement (SLA) by item using the [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api).\n\n## Enable the `useIndividualShippingEstimates` flag\n\nFirst, it is necessary to enable the [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) behavior to fill the `shippingEstimateDate` with the SLA information. To do so, you must update the store's `orderForm` with 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. You must include the flag `useIndividualShippingEstimates` to `true` as in the example shown.\n\nBy enabling this flag, the `shippingEstimateDate` will be updated with the SLA information configured by the sellers.\n\n## Add items to cart\n\nOnce you enable the `useIndividualShippingEstimates`, test if the configuration is correct by adding items to a shopping cart using the [Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/items) endpoint. See the request body example presented.\n\n## Send shipping data attachment\n\nSend the item shipping data to the `orderForm` using the [Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/attachments/shippingData) endpoint as in the example shown.\n\nOnce configured, the `orderForm` will retrieve the variable `shippingEstimateDate`, which will display the shipping estimate date instead of only the shipping estimate in business days.\n\nRequest\n\n`1\n\n{ \n\n2\n\n \"paymentConfiguration\": { \n\n3\n\n ... \n\n4\n\n }, \n\n5\n\n \"taxConfiguration\": null, \n\n6\n\n \"minimumQuantityAccumulatedForItems\": 1, \n\n7\n\n \"decimalDigitsPrecision\": 2, \n\n8\n\n \"minimumValueAccumulated\": null, \n\n9\n\n \"apps\": [ \n\n10\n\n ... \n\n11\n\n ], \n\n12\n\n \"allowMultipleDeliveries\": true, \n\n13\n\n \"allowManualPrice\": null, \n\n14\n\n \"savePersonalDataAsOptIn\": false, \n\n15\n\n \"maxNumberOfWhiteLabelSellers\": null, \n\n16\n\n \"recaptchaValidation\": \"vtexcriteria\", \n\n17\n\n \"recaptchaMinScore\": null, \n\n18\n\n \"recaptchaKeys\": null, \n\n19\n\n \"maskStateOnAddress\": true, \n\n20\n\n \"enableSecureCookies\": true, \n\n21\n\n \"useOwnershipCookie\": true, \n\n22\n\n \"ignoreProfileData\": null, \n\n23\n\n \"useIndividualShippingEstimates\": true \n\n24\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/customization/displaying-sla-by-item-in-checkout.md)\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[Enable the useIndividualShippingEstimates flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/guides/displaying-sla-by-item-in-checkout%23enable-the-useindividualshippingestimates-flag)\n\n[Add items to cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/guides/displaying-sla-by-item-in-checkout%23add-items-to-cart)\n\n[Send shipping data attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/guides/displaying-sla-by-item-in-checkout%23send-shipping-data-attachment)\n\nWas this helpful?\n\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/displaying-sla-by-item-in-checkout.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Enable the useIndividualShippingEstimates flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/guides/displaying-sla-by-item-in-checkout%23enable-the-useindividualshippingestimates-flag)\n\n[Add items to cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/guides/displaying-sla-by-item-in-checkout%23add-items-to-cart)\n\n[Send shipping data attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout/docs/guides/displaying-sla-by-item-in-checkout%23send-shipping-data-attachment)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0e26a646
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation using sandbox blocks in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-using-components)\n\n[Building a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n\n[Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-building-a-shelf)\n\n[Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)\n\n[Creating a native form for your store users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)\n\n[Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n\n[Overriding native app blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-overriding-native-app-blocks)\n\n[Using Sandbox blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-using-sandbox-blocks)\n\n[Using the Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-using-the-assets-builder)\n\n[Setting up Delivery Promise components (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/setting-up-delivery-promise-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-using-components)\n\n[Building a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n\n[Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-building-a-shelf)\n\n[Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)\n\n[Creating a native form for your store users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)\n\n[Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n\n[Overriding native app blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-overriding-native-app-blocks)\n\n[Using Sandbox blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-using-sandbox-blocks)\n\n[Using the Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-using-the-assets-builder)\n\n[Setting up Delivery Promise components (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/setting-up-delivery-promise-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/store-framework-using-components)\n\n[Using Sandbox blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-using-sandbox-blocks)\n\nUsing Sandbox blocks\n\nVTEX Store Framework is a very powerful tool meant to attend most client needs. It's understandable, though, that some custom requirements that your store needs and will not be served by the framework. That's where the **Sandbox App** comes in.\n\nThe **Sandbox App** is basically a component that supports iFrames. Therefore, it allows you to use custom `html`, `css` and `js` code to customize your store.\n\n## Instructions\n\n1. Open the `manifest.json` file and declare the Sandbox app as a dependency. \n\n2. Declare the Sandbox block in the `blocks` folder or in the `blocks.jsonc` file. \n`1 \n\"sandbox#h1\": { \n2 \n \"props\": { \n3 \n \"width\": \"100%\", \n4 \n \"height\": \"auto\", \n5 \n \"initialContent\": \"<h1 style=\\\"text-align:center;\\\">Hello World</h1>\", \n6 \n \"allowCookies\": false \n7 \n } \n8 \n} \n` \nLet's suppose you want to create a simple `h1` sandbox block. It would look similar to the following: \n\n3. Reference it in another's block `child dependency` or `blocks`. For instance, your `store.home`: \n`1 \n//home.jsonc \n2 \n\"store.home\": { \n3 \n \"blocks\": [ \n4 \n \"carousel#home\", \n5 \n \"sandbox#h1\", \n6 \n \"flex-layout.row#deals\", \n7 \n \"shelf#home\", \n8 \n \"info-card#home\", \n9 \n \"rich-text#question\", \n10 \n \"rich-text#link\", \n11 \n \"newsletter\" \n12 \n ] \n13 \n}, \n` \nThat should render the h1 sandbox on the store's page\n\n## Best practices\n\nIf you think that a component is very similar to what will serve your store needs but that it still needs some tweaks, you should find the right style and props to turn into the custom component you are looking for.\n\nSandbox should only be used whenever Store Framework native components won't handle your scenario and when what you intend to do is simple enough that it doesn't require a lot of outsource data. Creating everything using iFrames will make your store easily obsolete to new Store Framework features and not very good in terms of performance.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-using-sandbox-blocks.md)\n\n[Overriding native app blocks« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks//docs/guides/vtex-io-documentation-overriding-native-app-blocks)[Using the Assets BuilderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks//docs/guides/vtex-io-documentation-using-the-assets-builder)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-using-sandbox-blocks%23instructions)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-using-sandbox-blocks%23best-practices)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-using-sandbox-blocks.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-using-sandbox-blocks%23instructions)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks/docs/guides/vtex-io-documentation-using-sandbox-blocks%23best-practices)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_215d5f9b
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides controlling access to app resources in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/docs/guides/controlling-access-to-app-resources)\n\n[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/vtex-io-documentation-roles)\n\n[VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/vtex-io-documentation-vrn)\n\n[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/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/controlling-access-to-app-resources/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/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/controlling-access-to-app-resources/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/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/controlling-access-to-app-resources/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/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/controlling-access-to-app-resources/docs/guides/controlling-access-to-app-resources)\n\n[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/vtex-io-documentation-roles)\n\n[VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/vtex-io-documentation-vrn)\n\n[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/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/controlling-access-to-app-resources/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/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/controlling-access-to-app-resources/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/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/controlling-access-to-app-resources/docs/app-development)\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/vtex-io-documentation-policies)\n\n[Controlling access to app resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/controlling-access-to-app-resources)\n\nControlling access to app resources\n\nLearn how apps control access to their resources with policies.\n\nWhen developers implement [service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service), they must choose how the app's routes can be accessed. There are two kinds of policies: **role-based** and **resource-based**. The following table summarizes how each policy type works.\n\n| **Role-based** | **Resource-based** | |\n| --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Who can make the request? | Only other IO apps (acting on their own or [on behalf of other apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens)). | Another IO app (by itself or [on behalf of users and other apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens))Admin userIntegrations ([API keys](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6)) |\n| Supported API types | GraphQLREST | REST |\n| How other apps access the resource | They must declare the required policies in their manifest.json file and use [VTEX clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) to make API requests. | No policy declaration is required. They only need to use [VTEX clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients). |\n| How users and integrations (API keys) access the resource | Not applicable. | By calling the route and including an [authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens) in the header. |\n\nPolicies control access only for the owner of the authentication token. In scenarios where an IO app makes an API call to another app and uses an authentication token in the `VtexIdclientAutCookie` header, the policy will only have an allowing or denying effect for the token owner, regardless of whether they are a third-party app, a user, or an API key. Policies won't affect access control for the app making the API call in these scenarios.\n\n## Defining role-based policies\n\nRole-based policies are associated with a [role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) in the platform. Each policy specifies which resources (routes) and actions (HTTP methods) are allowed or denied. Apps must declare role-based policies to securely expose their resources when the requesters aren't specified. Role-based policies control access to the resource only for other apps.\n\nIf you are developing an app that requires access to resources with these policies, you must declare the policies in the `manifest.json` file for the desired resources and access them using a [client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients). For more information, see [Accessing external resources within a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/accessing-external-resources-within-a-vtex-io-app).\n\nRecommendations for using role-based policies:\n\n* The requesters are only apps that make requests independently or [on behalf of other apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens). Don't use role-based policies when requesters are users, integrations, or other [apps making requests on behalf of users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens).\n* Required for exposing GraphQL endpoints and optional for REST endpoints.\n* Compared to [resource-based policies](#defining-resource-based-policies), apps that want to access exposed resources must declare the necessary permissions in the `manifest.json` file.\n\n> To define access control for users and integrations, use [resource-based policies](#defining-resource-based-policies) for REST APIs and the [@auth directive](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps) for GraphQL APIs.\n\nTo declare a role-based policy for an app, create a `policies.json` file in the app's root folder. The basic structure of this file is as follows:\n\npolicies.json\n\n`1\n\n{ \n\n2\n\n { \n\n3\n\n \"name\": \"resolve-graphql\", \n\n4\n\n \"description\": \"Allows access to resolve a graphql request\", \n\n5\n\n \"statements\": [ \n\n6\n\n { \n\n7\n\n \"effect\": \"allow\", \n\n8\n\n \"actions\": [\"post\", \"get\"], \n\n9\n\n \"resources\": [ \n\n10\n\n \"vrn:vtex.store-graphql:{{region}}:{{account}}:{{workspace}}:/_v/graphql\" \n\n11\n\n ] \n\n12\n\n } \n\n13\n\n ] \n\n14\n\n } \n\n15\n\n} \n\n`\n\nNote that, in this example, a policy named `resolve-graphql` was declared, allowing an app to resolve a GraphQL request.\n\nBesides a `name` and a `description`, this policy includes the `statements` property.\n\nStatements are used to indicate whether to \"**allow/deny** these **actions** to be performed on these **resources** under these **conditions**\".\n\nTherefore, considering the given example, the declared `resolve-graphql` policy allows `POST` and `GET` requests on the `vrn:vtex.store-graphql:{{region}}:{{account}}:{{workspace}}:/_v/graphql` resource.\n\nThe keys that compose a statement are:\n\n* `effect`: Describes the effect of allowing (`allow`) or denying (`deny`) a resource to be accessed.\n* `actions`: Describes the actions (HTTP methods) related to a given effect and resource. \n> Depending on the resource, different actions can be performed on it. For RESTful APIs, this could map to HTTP verbs. However, actions aren't restricted to them, and the service may accept any string as an action.\n* `resources`: lists the resources expressed by a [VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vrn) to which the statement refers.\n\n## Defining resource-based policies\n\nResource-based policies are applied to routes defined in the `service.json` file. Routes can be public or private. Public routes are always accessible to everyone and don't require an [authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens). Private routes require authentication, and their policies define which actions (HTTP methods) are permitted by whom. If a private route has no policies, no one is allowed to perform any action on this route.\n\nApps must declare resource-based policies to securely expose their private resources (routes) for specific requesters (users, integrations, or other apps). Apps accessing the exposed resources don't need to declare policies in the `manifest.json` file.\n\nRecommendations for using resource-based policies:\n\n* Required when the requesters are users, integrations, or other [apps making requests on behalf of users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens). Optional for other apps that make requests by themselves or on [behalf of other apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens).\n* Optional for exposing REST endpoints. Incompatible with GraphQL endpoints.\n* Compared to [role-based policies](#defining-role-based-policies), apps exposing resources can control which other apps can access private routes through resource-based policies.\n\nTo create a resource-based policy, the resource itself must list who it trusts. Therefore, since the resource's routes are declared in a `service.json` file, a resource-based policy must be declared in this file as a `routes` property.\n\nThe `service.json` file must have something similar to the following:\n\nnode/service.json\n\n`1\n\n{ \n\n2\n\n \"routes\": { \n\n3\n\n \"new-order\": { \n\n4\n\n \"path\": \"/orders\", \n\n5\n\n \"public\": false, \n\n6\n\n \"policies\": [{ \n\n7\n\n \"effect\": \"allow\", \n\n8\n\n \"actions\": [\"post\"], \n\n9\n\n \"principals\": [ \n\n10\n\n \"vrn:apps:*:*:*:app/example.marketplace@*\" \n\n11\n\n ] \n\n12\n\n }] \n\n13\n\n } \n\n14\n\n } \n\n15\n\n} \n\n`\n\nNote that, in this example, a resource-based policy related to the `/orders` route was declared. The `effect`, `actions`, and `principals` properties under `policies` can be interpreted as: \"**allow/deny** these **actions** to be performed by these **principals** on this **route**\", where principals are the applications able to make requests on a given resource.\n\nHence, for the given example, a policy related to the `/orders` resource allows the `example.marketplace` app to perform a `POST` request on its route.\n\nThe keys that compose this kind of policy are:\n\n* `effect`: Describes the effect of allowing (`allow`) or denying (`deny`) a principal to perform a set of actions on a route.\n* `actions`: Describes the actions related to a given effect, principal, and route.\n* `principals`: Lists the principals allowed or denied to perform requests to a given route. Like resources, `principals` are also expressed by a [VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vrn).\n\n> Policies denying access have priority over those allowing access. If actions and principals intersect across different policies for a route, this subset of principals will be denied access for these actions.\n\n### Principal types\n\nThe following table summarizes the resource-based policy usage for each type of principal.\n\n| Principal type | service (VRN element) | path (VRN element) |\n| ----------------------- | --------------------- | ------------------------------------- |\n| Other apps | apps | app/{vendor}.{app-name}@{app-version} |\n| Users | vtex.vtex-id | user/{email} |\n| Integrations (API keys) | vtex.vtex-id | user/vtexappkey-{account}-{hash} |\n\nThe following sections show how VRNs are used for each type of principal, with examples.\n\n#### Other apps\n\nBy default, other apps aren't allowed to access private resources exposed through resource-based policies unless they are included in the `principals` list of a policy allowing it (`\"effect\": \"allow\"`).\n\nTo include other apps in the `principals` list, use the following VRN syntax:\n\n* Set the `service` element of the VRN to `apps`.\n* The `path` element uses the format `app/{vendor}.{app-name}@{app-version}`. The `*` wildcard can be used. For instance:\n* `app/*` covers all apps\n* `app/{vendor}.*` covers all apps of a specific vendor\n* `app/{vendor}.{app-name}@*` covers all versions of a specific app\n* `app/{vendor}.{app-name}@{major}.*` covers all versions of a specific app's major version\n\nThe example below illustrates two policies with intersecting principals that use wildcards. The first policy allows all apps to use the `POST` method on a route. The second policy denies access to the same route and method, but for all versions of two specific apps.\n\nnode/service.json\n\n`1\n\n{ \n\n2\n\n ... \n\n3\n\n \"policies\": [{ \n\n4\n\n \"effect\": \"allow\", \n\n5\n\n \"actions\": [\"post\"], \n\n6\n\n \"principals\": [ \n\n7\n\n \"vrn:apps:*:*:*:app/*\" \n\n8\n\n ] \n\n9\n\n }, \n\n10\n\n { \n\n11\n\n \"effect\": \"deny\", \n\n12\n\n \"actions\": [\"post\"], \n\n13\n\n \"principals\": [ \n\n14\n\n \"vrn:apps:*:*:*:app/{vendor1}.{app-name1}@*\", \n\n15\n\n \"vrn:apps:*:*:*:app/{vendor2}.{app-name2}@*\" \n\n16\n\n ] \n\n17\n\n }] \n\n18\n\n} \n\n`\n\n#### Users and integrations\n\nBy default, users and integrations (API keys) aren't allowed to access private resources exposed through resource-based policies unless they are included in the `principals` list of a policy allowing it (`\"effect\": \"allow\"`).\n\nTo include users and integrations in a principal, use the following VRN syntax:\n\n* Set the `service` element of the VRN as `vtex.vtex-id`.\n* The `path` element uses the format `user/{username}`. `{username}` can be the user email or the `appkey` of the integration in the format `vtexappkey-{account}-{hash}`. You can use the `*` wildcard. For example:\n* `user/*` covers all users and appkeys\n* `user/*@*` covers all users\n* `user/*@gmail.com` covers all users with the email domain `gmail.com`\n* `user/vtexappkey-*` covers all appkeys\n* `user/vtexappkey-{account}-*` covers all appkeys of a specific account\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-policies/controlling-access-to-app-resources.mdx)\n\n[Accessing external resources within a VTEX IO app« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources//docs/guides/accessing-external-resources-within-a-vtex-io-app)[RolesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources//docs/guides/vtex-io-documentation-roles)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Defining role-based policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/controlling-access-to-app-resources%23defining-role-based-policies)\n\n[Defining resource-based policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/controlling-access-to-app-resources%23defining-resource-based-policies)\n\n[Principal types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/controlling-access-to-app-resources%23principal-types)\n\nWas this helpful?\n\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/controlling-access-to-app-resources.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Defining role-based policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/controlling-access-to-app-resources%23defining-role-based-policies)\n\n[Defining resource-based policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/controlling-access-to-app-resources%23defining-resource-based-policies)\n\n[Principal types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/controlling-access-to-app-resources/docs/guides/controlling-access-to-app-resources%23principal-types)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_3cd1ce28
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides get banner list for a specific search in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/consult-store-search-terms-information)\n\n[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/consult-product-search-information)\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/get-banner-list-for-a-specific-search)\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/access-control-list)\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/delivery-promise-for-headless-stores)\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/consult-store-search-terms-information)\n\n[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/consult-product-search-information)\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/get-banner-list-for-a-specific-search)\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/access-control-list)\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/delivery-promise-for-headless-stores)\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides)\n\nSearch\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search/docs/guides/get-banner-list-for-a-specific-search)\n\nGet banner list for a specific search\n\nIt is possible to display banners as promotional actions on the customer's search result page. This process is done through an association between the words and facets that represent filters selected when making a search. For more information on how to configure a banner, check the [Configuring Banners](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4ViKEivLJtJsvpaW0aqIQ5%23) article.\n\nTo retrieve a list of banners for a specific search, use the [Get list of banners registered for query](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Fbanners-facets) endpoint. You can filter the endpoint response by defining the search’s `facets` and the term's `locale` and `query`.\n\n**Response body example:**\n\n`1\n\n{ \n\n2\n\n \"banners\": [ \n\n3\n\n { \n\n4\n\n \"id\": \"summersale\", \n\n5\n\n \"name\": \"Summer Sale\", \n\n6\n\n \"area\": \"1\", \n\n7\n\n \"html\": \"<h1>This is a test</h1>\" \n\n8\n\n } \n\n9\n\n ] \n\n10\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Search/get-banner-list-for-a-specific-search.md)\n\n[Consult product search information« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search//docs/guides/consult-product-search-information)[Get a list of the possible facets for a specific searchNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-banner-list-for-a-specific-search//docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Search/get-banner-list-for-a-specific-search.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_ef5a9da3
|
[
{
"role": "system",
"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 blueknow 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.blueknow/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/api-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.blueknow/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.blueknow/docs/storefront-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.blueknow/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.blueknow/docs/troubleshooting)\n\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.blueknow/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/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.blueknow/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/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.blueknow/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.blueknow/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/guides/pixel-apps)\n\nBlueknow app\n\nOfficial extension\n\nVersion: 1.0.0\n\nLatest version: 1.0.0\n\n[](#contributors-)\n\nBlueknow first party app\n\n## Configuration\n\nIt is possible to install in your store either by using App Store or the VTEX IO Toolbelt.\n\n### Using VTEX App Store\n\n1. Access the **Apps** section in your account's admin page and look for the Blueknow box;\n2. Then, click on the **Install** button;\n3. You'll see a warning message about needing to enter the necessary configurations. Scroll down and type in your **Blueknow ID** in the `Blueknow` field.\n4. Click on **Save**.\n\n### Using VTEX IO Toolbelt\n\n1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/installing-an-app/) the `vtex.blueknow@1.x` app. You can confirm that the app has now been installed by running `vtex ls` again.\n2. Access the **Apps** section in your account's admin page and look for the Blueknow box. Once you find it, click on the box.\n3. Fill in the `Blueknow` field with your **Blueknow ID**.\n4. Click on **Save**.\n\n[Bluecore« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.bluecore)[BTG360Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.btg360)\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.blueknow/docs/apps/vtex.blueknow%23configuration)\n\n[Using VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.blueknow%23using-vtex-app-store)[Using VTEX IO Toolbelt](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.blueknow/docs/apps/vtex.blueknow%23using-vtex-io-toolbelt)\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_dfe53650
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX product summary 2.91.0 ProductSummaryName app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/vtex-io-apps)\n\nProduct Summary Name\n\n[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)\n\nVersion: 2.91.0\n\nLatest version: 2.91.0\n\nProduct Summary Name is a block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering the product name.\n\n\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary-name` block to your store theme as a child of `product-summary.shelf`. For example:\n\n`1\n\n \"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-image\", \n\n4\n\n+ \"product-summary-name\", \n\n5\n\n \"product-summary-space\", \n\n6\n\n \"product-summary-column#1\" \n\n7\n\n ] \n\n8\n\n }, \n\n`\n\n1. Then, declare the `product-summary-name` and configure its behavior using the props stated below.\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------ | --------------------------------------------- | --------------------------------------------------------------------- |\n| showFieldsProps | object | Defines the visibility on certain properties. | { showProductReference: false, showBrandName: false, showSku: false } |\n| tag | string | HTML tag used. It can be: div, h1, h2, h3. | h1 |\n\n* `showFieldsProps` object:\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------- | ---------------------- | ------------- |\n| showSku | Boolean | Show product SKU | false |\n| showProductReference | Boolean | Show product reference | false |\n| showBrandName | Boolean | Show brand name | false |\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| nameContainer |\n| nameWrapper |\n| brandName |\n| skuName |\n| productReference |\n| productNameLoader |\n\nSee also\n\n[Vtex.product SummaryVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/apps/vtex.product-summary)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName%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_ed0d0153
|
[
{
"role": "system",
"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 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/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/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/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/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/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/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/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/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/backtotopbutton/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/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/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/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/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/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/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/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/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/backtotopbutton/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/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/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/backtotopbutton/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/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/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/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/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/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/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/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/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/backtotopbutton/docs/vtex-io-apps)\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/guides/store-components)\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\n[Availability Subscriber« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/availabilitysubscriber)[ImageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/image)\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/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/backtotopbutton/docs/apps/vtex.store-components/backtotopbutton%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/backtotopbutton%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/backtotopbutton/docs/apps/vtex.store-components/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_3d42bb2d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides storefront performance in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-performance)\n\n[Getting started with Lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-getting-started-with-lighthouse)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-seo)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-performance)\n\n[Getting started with Lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-getting-started-with-lighthouse)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-seo)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/storefront-development)\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-best-practices)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-performance)\n\nPerformance\n\nExplore best practices and tools for continuously optimizing website performance.\n\nIn ecommerce, website performance directly impacts the shopper experience. It may affect **sales conversion rate**, **user session time**, and other relevant metrics. Every millisecond counts, influencing the shopper's decision-making process and affecting your store's **search engine ranking**. Therefore, ensuring that your website is as fast and performant as possible is crucial, which leads to **high scores in [Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview) audits**.\n\n## Performance slowdowns\n\nAs your project becomes more complex, many factors may slow down website performance. For this reason, maintaining optimal website performance is a **continuous effort** that requires commitment.\n\nSome things to keep in mind:\n\n* **Third-party scripts:** Third-party scripts are one of the leading causes of performance slowdowns. These scripts trigger additional network requests to multiple servers and are likely to block DOM construction, keeping the main thread busy and delaying page rendering.\n* **Page weight:** Page weight is the total size of a web page, including all the resources that need loading (i.e., images, stylesheets, and other static files). The heavier the files and data your website sends to the client, the longer the browser takes to render your page. Hence, reducing page weight is a great opportunity to improve website performance. \nPage weight issues are mainly related to: \n * Uncompressed files. \n * Unoptimized images. \n * Unoptimized fonts. \n * Unclean code.\n* **HTTP requests:** When a user visits a web page, the browser sends multiple HTTP requests to load all the resources (i.e., images, stylesheets, fonts, etc.) needed to render the web page. Downloading these resources, however, significantly impacts the loading time of the page. Therefore, besides optimizing images, compressing files, and reducing download size, it is also important to consider minimizing download frequency.\n* **Render-blocking resources:** Render-blocking resources are scripts, stylesheets, and code files sequentially downloaded, parsed, and executed by the browser. When the browser faces a render-blocking resource, it stops the entire rendering process until these critical files are processed first. Although these resources take a considerable time for the browser to process, they may not be crucial for the user experience.\n\n## Monitoring tools\n\nThere are several tools available for identifying performance issues and helping improve website performance, such as:\n\n* [Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview)/[PageSpeed Insights](https://read.calvincode.net/reader?url=https://pagespeed.web.dev/): An open-source automated tool created by Google used to identify common problems related to the quality of a webpage through audits.\n* [SpeedCurve](https://read.calvincode.net/reader?url=https://speedcurve.com/): Live dashboards that monitor web application experience across different browsers and platforms and provide visibility over performance.\n* [PartyTown](https://read.calvincode.net/reader?url=https://partytown.builder.io/): A lazy-loaded library to help relocate resource-intensive scripts into a [web worker](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/API/Web%5FWorkers%5FAPI), keeping them off the [main thread](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Glossary/Main%5Fthread).\n* [Google DevTools](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/devtools/): A set of web developer tools built directly into the Google Chrome browser.\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/storefront-best-practices/storefront-performance.md)\n\n[Analytics« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance//docs/guides/storefront-analytics)[Getting started with LighthouseNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance//docs/guides/storefront-getting-started-with-lighthouse)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Performance slowdowns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-performance%23performance-slowdowns)\n\n[Monitoring tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-performance%23monitoring-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/vtex-io/Storefront-Guides/storefront-best-practices/storefront-performance.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Performance slowdowns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-performance%23performance-slowdowns)\n\n[Monitoring tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance/docs/guides/storefront-performance%23monitoring-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_45d4c15b
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides using dynamic expressions on master data v2 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-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/using-dynamic-expressions-on-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-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/using-dynamic-expressions-on-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/master-data)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\nUsing dynamic expressions on Master Data v2\n\nLearn how to automate processes based on Document updates using dynamic expressions.\n\nDynamic expressions on Master Data v2 enable you to populate document fields dynamically, making it easier to automate tasks like sending personalized marketing emails or processing document updates. This guide explains how to configure and use dynamic expressions with JSON schemas.\n\n## Syntax\n\nDynamic expressions use placeholders to reference and retrieve values from Document fields, including nested fields. These expressions enable dynamic data usage in actions like sending emails or saving data to another entity.\n\n* **Basic syntax:** Use `{!fieldName}` to reference a top-level field. For example: \n`1 \n{!email} \n`\n* **Nested fields:** Use dot notation to reference fields within nested objects. For example: \n`1 \n{!order.clientProfileData.email} \n`\n\n## Before you begin\n\nBefore using dynamic expressions, ensure you have a [JSON schema](https://read.calvincode.net/reader?url=https://json-schema.org/) configured for your Data Entity in Master Data v2\\. For more information, refer to [Creating JSON Schemas for a Data Entity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-json-schemas-in-master-data-v2).\n\n## Instructions\n\n### Step 1: Creating a trigger\n\nFollow the instructions in the [Setting up triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2) guide to create a trigger in Master Data v2\\. This defines when the action will be triggered (e.g., Document creation) and what action will be taken.\n\n### Step 2: Configuring a trigger to use dynamic expressions\n\nIn the trigger's `action` object, use dynamic expressions to populate the desired fields. For example:\n\n`1\n\n{ \n\n2\n\n \"v-triggers\": [ \n\n3\n\n { \n\n4\n\n \"name\": \"email-notification\", \n\n5\n\n \"active\": true, \n\n6\n\n \"action\": { \n\n7\n\n \"type\": \"email\", \n\n8\n\n \"provider\": \"default\", \n\n9\n\n \"to\": \"{!email}\", \n\n10\n\n \"subject\": \"Welcome, {!name}!\", \n\n11\n\n \"body\": \"Hello, {!name}. Your order ID is {!order.id}.\" \n\n12\n\n } \n\n13\n\n } \n\n14\n\n ] \n\n15\n\n} \n\n`\n\nIn this example, the `to` field dynamically retrieves the value of the `email` field from the Document, while the `subject` and `body` incorporate values from `name` and `order.id`.\n\n> Ensure all fields referenced in your dynamic expressions exist in the JSON schema of your Data Entity.\n\n### Step 3: Testing the trigger\n\nTest the configuration using a sample document to validate your trigger configuration and the dynamic expressions. Here’s an example document:\n\n`1\n\n{ \n\n2\n\n \"email\": \"customer@example.com\", \n\n3\n\n \"name\": \"Alice\", \n\n4\n\n \"order\": { \n\n5\n\n \"id\": \"98765\" \n\n6\n\n } \n\n7\n\n} \n\n`\n\nThe expected output in the triggered email would be:\n\n`1\n\nTo: customer@example.com \n\n2\n\nSubject: Welcome to Our Store, Alice! \n\n3\n\nBody: Hi Alice, thank you for your order #98765. \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/using-dynamic-expressions-on-master-data-v2.md)\n\n[Creating relationships between data entities using Master Data v2« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2//docs/guides/creating-relationships-between-data-entities-using-master-data-v2)[Searching by geocoordinates in Master Data v2Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2//docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\nSee also\n\n[Setting up triggers on Master Data v2Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Syntax](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23syntax)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23instructions)\n\n[Step 1: Creating a trigger](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23step-1-creating-a-trigger)[Step 2: Configuring a trigger to use dynamic expressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23step-2-configuring-a-trigger-to-use-dynamic-expressions)[Step 3: Testing the trigger](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23step-3-testing-the-trigger)\n\nWas this helpful?\n\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/using-dynamic-expressions-on-master-data-v2.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Syntax](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23syntax)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23instructions)\n\n[Step 1: Creating a trigger](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23step-1-creating-a-trigger)[Step 2: Configuring a trigger to use dynamic expressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23step-2-configuring-a-trigger-to-use-dynamic-expressions)[Step 3: Testing the trigger](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2%23step-3-testing-the-trigger)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4e9f5653
|
[
{
"role": "system",
"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 rich text 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.rich-text/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/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/apps/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/apps/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/apps/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/apps/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/apps/vtex.rich-text/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/vtex.rich-text/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/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/apps/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/apps/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/apps/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/apps/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/apps/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/apps/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/apps/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/apps/vtex.rich-text/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/vtex.rich-text/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/vtex.rich-text/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/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/apps/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/apps/vtex.rich-text/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/vtex.rich-text/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/vtex.rich-text/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/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/apps/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/apps/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/apps/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/apps/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/apps/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/apps/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/apps/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/apps/vtex.rich-text/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/vtex.rich-text/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/vtex.rich-text/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/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/apps/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/apps/vtex.rich-text/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/vtex.rich-text/docs/apps/vtex.product-summary/productsummaryskuname)[SearchNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/vtex.rich-text/docs/apps/vtex.rich-text%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/docs/apps/vtex.rich-text%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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_8a189723
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides developing services on vtex io in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/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/developing-services-on-vtex-io/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/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/developing-services-on-vtex-io/docs/guides/developing-services-on-vtex-io)\n\nDeveloping services on VTEX IO\n\nThe VTEX IO platform allows developers to create unique commerce experiences using Web technologies. It’s possible to create frontend blocks for Store Framework, backend services exposing REST or GraphQL APIs, and combine a series of VTEX modules into a complete solution, packaging it into an app.\n\nAs VTEX IO powers big ecommerce operations, they require running code on a server. **Services** are how we run **Node.js** or **.NET** code on VTEX IO infrastructure, backed by API abstractions to improve developer experience.\n\nBy the end of this tutorial, you will be able to export routes, handle events, and connect with internal and external applications, in order to make your application even better and make the most of VTEX's infrastructure.\n\n* [service-course-template](https://read.calvincode.net/reader?url=https://github.com/vtex-trainings/service-course-template)\n* [events-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/events-example)\n\n## Understanding services\n\nA **Service** must be exported from a VTEX IO app, just like themes or store blocks, using `node` or `dotnet` builders. With these, you are able to develop a REST API without having to set up a server, GraphQL APIs and routes.\n\nServices in VTEX IO support one-command rollbacks and continuous integration. They can export internal and external routes and run on top of Kubernetes. You can count on VTEX IO to manage the scalability of your services.\n\nInside the `/node` folder of a service is a `service.json` file, where it's possible to declare routes that the service must respond to and other configurations like timeout and memory.\n\nDuring this course, you will implement some services in VTEX IO and learn more about the possibilities they offer to your development.\n\n## Overview\n\n1. [Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate)\n2. [Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events)\n3. [Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client)\n4. [Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-4-using-events-as-triggers)\n5. [Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client)\n6. [GraphQL: Retrieving data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n7. [Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-7-using-graphiql)\n8. [Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion)\n\n## Before you begin\n\nMake sure you check the technical requirements to complete this project:\n\n* Basic knowledge of [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/learn/).\n* Experience developing in [Typescript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/) language.\n* The VTEX IO CLI is installed on your computer.\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/developing-services-on-vtex-io.mdx)\n\n[Services« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io//docs/guides/vtex-io-documentation-service)[1\\. Getting started with the boilerplateNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io//docs/guides/services-1-getting-started-with-the-boilerplate)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Understanding services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/developing-services-on-vtex-io%23understanding-services)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/developing-services-on-vtex-io%23overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/developing-services-on-vtex-io%23before-you-begin)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/developing-services-on-vtex-io.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Understanding services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/developing-services-on-vtex-io%23understanding-services)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/developing-services-on-vtex-io%23overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io/docs/guides/developing-services-on-vtex-io%23before-you-begin)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_6ece9e3c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration app graphql api in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-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/guides/external-marketplace-integration-app-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/guides/external-marketplace-integration-app-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/guides/external-marketplace-integration-app-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/guides/external-marketplace-integration-app-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/guides/external-marketplace-integration-app-graphql-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-template)\n\n[External Marketplace Integration app GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-template)\n\n[External Marketplace Integration app GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-guide)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-template)\n\n[External Marketplace Integration app GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api)\n\nExternal Marketplace Integration app GraphQL API\n\nGraphQL API reference for the External Marketplace integration app.\n\nThis document outlines the GraphQL API for managing external marketplace integrations within the VTEX ecosystem, provided via the [mkp-app-template](https://read.calvincode.net/reader?url=https://github.com/vtex/mkp-app-template) app template. The API enables querying and modifying integration settings, including sales channel configurations, affiliate mappings, and account details.\n\n## Schema overview\n\n### Query\n\ngetConfiguration\n\ngetSalesChannel\n\nConfiguration\n\naccountName String\n\nactive Boolean\n\naffiliateId String\n\nsalesChannel String\n\nemail String\n\nallowFranchiseAccounts Boolean\n\nSalesChannel\n\nId ID!\n\nName String\n\nCountryCode String\n\nCultureInfo String\n\nTimeZone String\n\nCurrencyCode String\n\nQuery\n\ngetConfiguration Configuration\n\ngetSalesChannel(salesChannelId String) : SalesChannel\n\n| Field | Argument | Type | Description |\n| -------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **getConfiguration** | [Configuration](#configuration) | Retrieves the current marketplace integration configuration, including account settings, affiliate details, and sales channel information. | |\n| **getSalesChannel** | [SalesChannel](#saleschannel) | Retrieves detailed properties of a specific sales channel using its unique ID. | |\n| salesChannelId | String | Sales channel ID. | |\n\n### Mutation\n\nMutation\n\nsaveConfiguration(config ConfigurationInput) : String\n\ncreateSalesChannel(salesChannelData SalesChannelInput) : String\n\n| Field | Argument | Type | Description |\n| ---------------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **saveConfiguration** | String | Updates the integration configuration with the provided settings. Returns a success message or error if the operation fails. | |\n| config | [ConfigurationInput](#configurationinput) | Properties of the configuration to be saved. | |\n| **createSalesChannel** | String | Creates or updates a sales channel with the provided information. Returns a success message or error if the operation fails. | |\n| salesChannelData | [SalesChannelInput](#saleschannelinput) | Sales channel properties to be created or modified. | |\n\n## Schema description\n\n> Arguments must be provided by the user. Required fields are marked with an exclamation mark (`!`).\n\n### Configuration\n\n| Field | Type | Description |\n| -------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **accountName** | String | Account name where the integration is installed. |\n| **active** | Boolean | Indicates whether the integration is active. If true, the integration is active. If false, the integration is inactive. |\n| **affiliateId** | String | ID (3 consonants) that represents the connection with the external marketplace. The ID needs to be unique in the VTEX seller account. Example: LVL. |\n| **salesChannel** | String | Sales channel ID, which defines the catalog that will be sent to the marketplace. Example: 1. |\n| **email** | String | Email that will receive VTEX notifications related to the affiliate. |\n| **allowFranchiseAccounts** | Boolean | Indicates whether the integration allows franchise accounts. If true, the integration allows them. If false, the integration doesn't allow them. |\n\n[Query](#query) 🔼\n\n### SalesChannel\n\n| Field | Type | Description |\n| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Id** | ID! | Sales channel ID. Example: 1. |\n| **Name** | String | Sales channel name. Example: \"Marketplace channel\". |\n| **CountryCode** | String | Sales channel country code in [ISO 3166-1 alpha-2 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F3166-1%5Falpha-2%23Officially%5Fassigned%5Fcode%5Felements) for the external marketplace. Example: \"US\". |\n| **CultureInfo** | String | Sales channel culture information for the external marketplace in [IETF BCP 47 format](https://read.calvincode.net/reader?url=https://www.rfc-editor.org/info/bcp47) and combining a language code in [ISO-639 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/List%5Fof%5FISO%5F639%5Flanguage%5Fcodes) and a region code in [ISO 3166-1 alpha-2 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F3166-1%5Falpha-2%23Officially%5Fassigned%5Fcode%5Felements). Example: \"en-US\". |\n| **TimeZone** | String | Sales channel [time zone name](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) for the external marketplace. Example: \"Pacific Standard Time\". |\n| **CurrencyCode** | String | Sales channel currency code in [ISO 4217 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F4217%23List%5Fof%5FISO%5F4217%5Fcurrency%5Fcodes) for the external marketplace. Example: \"USD\". |\n\n[Query](#query) 🔼\n\n### ConfigurationInput\n\n| Field | Type | Description |\n| -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **accountName** | String | Name of the account where the integration is installed. |\n| **active** | Boolean | Property that defines if the integration is active. If true, the integration is active. If false, the integration is inactive. |\n| **affiliateId** | String | ID (3 consonants) that represents the connection with the external marketplace. The ID needs to be unique in the VTEX seller account. Example: LVL. |\n| **salesChannel** | String | Sales channel ID, which defines the catalog that will be sent to the marketplace. Example: 1. |\n| **email** | String | Email that will receive VTEX notifications related to the affiliate. |\n| **allowFranchiseAccounts** | Boolean | Property that defines if the integration allows franchise accounts. If true, the integration allows them. If false, the integration doesn't allow them. |\n\n[Mutation](#mutation) 🔼\n\n### SalesChannelInput\n\n| Field | Type | Description |\n| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Id** | ID! | Sales channel ID. Example: 1. |\n| **Name** | String | Sales channel name. Example: \"Marketplace channel\". |\n| **CountryCode** | String | Sales channel country code in [ISO 3166-1 alpha-2 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F3166-1%5Falpha-2%23Officially%5Fassigned%5Fcode%5Felements) for the external marketplace. Example: \"US\". |\n| **CultureInfo** | String | Sales channel culture information for the external marketplace in [IETF BCP 47 format](https://read.calvincode.net/reader?url=https://www.rfc-editor.org/info/bcp47) and combining a language code in [ISO-639 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/List%5Fof%5FISO%5F639%5Flanguage%5Fcodes) and a region code in [ISO 3166-1 alpha-2 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F3166-1%5Falpha-2%23Officially%5Fassigned%5Fcode%5Felements). Example: \"en-US\". |\n| **TimeZone** | String | Sales channel [time zone name](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) for the external marketplace. Example: \"Pacific Standard Time\". |\n| **CurrencyCode** | String | Sales channel currency code in [ISO 4217 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F4217%23List%5Fof%5FISO%5F4217%5Fcurrency%5Fcodes) for the external marketplace. Example: \"USD\". |\n\n[🔼 Mutation](#mutation)\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/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-app-graphql-api.md)\n\n[Creating an integration app from a Template« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api//docs/guides/external-marketplace-integration-app-template)[Catalog IntegrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api//docs/guides/external-marketplace-integration-catalog)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23schema-description)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23configuration)[SalesChannel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23saleschannel)[ConfigurationInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23configurationinput)[SalesChannelInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23saleschannelinput)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-app-graphql-api.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23schema-description)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23configuration)[SalesChannel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23saleschannel)[ConfigurationInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23configurationinput)[SalesChannelInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23saleschannelinput)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_bbf53f6f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides app development 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/app-development-guides/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-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/app-development-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/app-development-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/app-development-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/app-development-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/app-development-guides/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/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/app-development-guides/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/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/app-development-guides/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides)\n\nCustom app development guides\n\nStep by step guides on how to solve real-world issues when developing custom VTEX IO apps and backend integrations.\n\n## Setting up your workspace\n\nSet up your local environment: start new projects, sync your local files to the cloud, and manage development logs.\n\n* [Creating a development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace)\n* [Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app)\n* [Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app)\n\n## Service development\n\nDevelop new functionalities by building service apps and integrating clients.\n\n* [Using and creating clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io)\n* [Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n* [Connecting to VTEX core commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)\n* [Receiving order notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io)\n* [Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs)\n\n## App deployment\n\nMake your new VTEX IO app or storefront customizations available to end users.\n\n* [Releasing a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version)\n* [Publishing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app)\n* [Deploying the app's stable version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version)\n* [Promoting a workspace to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)\n\n## Edition Apps\n\nBecome a Sponsor Account and manage the Edition Apps of your child accounts.\n\n* [Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n* [Configuring an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n* [Updating Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-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/App-Guides/app-development-guides.md)\n\n[Creating an interface for your app settings« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides//docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)[ServicesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides//docs/guides/vtex-io-documentation-service)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Setting up your workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23setting-up-your-workspace)\n\n[Service development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23service-development)\n\n[App deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23app-deployment)\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23edition-apps)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/app-development-guides.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Setting up your workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23setting-up-your-workspace)\n\n[Service development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23service-development)\n\n[App deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23app-deployment)\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23edition-apps)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_5c13f2b1
|
[
{
"role": "system",
"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 vtexarg.product highlight by vtex segment 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/vtexarg.product-highlight-by-vtex-segment/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/api-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/vtexarg.product-highlight-by-vtex-segment/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/vtexarg.product-highlight-by-vtex-segment/docs/storefront-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/vtexarg.product-highlight-by-vtex-segment/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/vtexarg.product-highlight-by-vtex-segment/docs/troubleshooting)\n\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/vtexarg.product-highlight-by-vtex-segment/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/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/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/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/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/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/vtexarg.product-highlight-by-vtex-segment/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/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/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/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/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/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/vtexarg.product-highlight-by-vtex-segment/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/vtexarg.product-highlight-by-vtex-segment/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/advanced-components)\n\nProduct Highlight by VTEX Segment\n\nOfficial extension\n\nVersion: 0.3.2\n\nLatest version: 0.3.2\n\n[](#contributors-)\n\nThe **Product Highlight by VTEX Segment** app allows shoppers to select a Whitelabel Seller available in their region, and it filters the product listing results accordingly. The app also uses a badge to highlight products of Whitelabel Sellers that are available in the shopper's region.\n\n\n\n---\n\n## Before you start\n\nBefore configuring the **Product Highlight by VTEX Segment** app, make sure to create a collection for each Whitelabel Seller of your store (_See [Creating Collections Beta](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-collections-beta) for more information)._ When naming your collection, make sure to use the following naming structure: `{sellerId}-{defaultCollectionName}`, where the `{sellerId}` is the `sellerId` of the Whitelabel Seller and `{defaultCollectionName}` is the name of the Collection.\n\n\n\n---\n\n## Configuration\n\nTo configure the **Product Highlight by VTEX Segment** app, you'll need to:\n\n1. Set up the default configurations of the **Product Highlight by VTEX Segment** app via the VTEX Admin.\n2. Add the **Product Highlight by VTEX Segment** to the store theme.\n\nBy the end of these steps, you'll have your store products highlighted according to the Whitelabel Seller selected.\n\n## Setting up the Product Highlights app\n\n1. Open the terminal and log in to the desired VTEX account using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n2. Install the `vtexarg.product-highlight-by-vtex-segment` app on your account. \n`1 \nvtex install vtexarg.product-highlight-by-vtex-segment \n`\n3. Open the VTEX Admin.\n4. Go to **Account Settings > Apps > My apps**.\n5. Look for the **Product Highlight by VTEX Segment** app and click on **Settings**. \n\n6. Fill in the presented fields as in the following: \n * **Default Seller Id** \\- Enter the default seller ID to use in cases the shopper's region is not detected (e.g., `jumboargentinav692lanus692`). \n * **Default Collection Name** \\- Enter the name of the collection corresponding to the default seller ID (e.g., `leyDeGondolas`). This is the `{defaultCollectionName}` part of the **Collection Name** (_See [Before you start](#before-you-start) for more information_). \n * **Image Url of Highlight** \\- Enter the URL of the ximage badge that will highlight the products. For example: \n \n7. Click on **Save**.\n\n### Adding the Product Highlights component to your store theme\n\n1. Open your store theme in any code editor of your choice.\n2. Open the `manifest.json` file and add the `vtexarg.product-highlight-by-vtex-segment` app as a peer dependency of your theme: \n`1 \n\"peerDependencies\": { \n2 \n ... \n3 \n+ \"vtexarg.product-highlight-by-vtex-segment\": \"0.x\" \n4 \n ... \n5 \n} \n`\n3. Add the `product-highlight-by-vtex-segment` block to any child of the `store.product` template (Product Details Page template). For example: \n`1 \n\"store.product\": { \n2 \n \"children\": [ \n3 \n \"flex-layout.row#product-main\", \n4 \n ] \n5 \n}, \n6 \n\"flex-layout.row#product-main\": { \n7 \n \"children\": [ \n8 \n \"flex-layout.col#right-col\" \n9 \n ] \n10 \n}, \n11 \n\"flex-layout.col#right-col\": { \n12 \n \"children\": [ \n13 \n+ \"product-highlight-by-vtex-segment\" \n14 \n ] \n15 \n} \n`\n\nNow, see the [Customization](#customization) section to add custom styles to your component.\n\nAfter [linking your store theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-linking-an-app) in a development workspace, you'll be able to select a Whitelabel Seller available in your region from a dropdown menu list.\n\n\n\nYou'll then be able to see the chosen badge in the product cards of the selected Whitelabel Seller's collection.\n\n\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| -------------------------------------- |\n| productHighlightByVtexSegmentContainer |\n| imageOfHighlight |\n\n---\n\n[Product Gifts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-gifts)[Product Specification BadgesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-specification-badges)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.product-highlight-by-vtex-segment%23before-you-start)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.product-highlight-by-vtex-segment%23configuration)\n\n[Setting up the Product Highlights app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.product-highlight-by-vtex-segment%23setting-up-the-product-highlights-app)\n\n[Adding the Product Highlights component to your store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.product-highlight-by-vtex-segment%23adding-the-product-highlights-component-to-your-store-theme)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.product-highlight-by-vtex-segment%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_3a285e33
|
[
{
"role": "system",
"content": "You are a VTEX 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 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/seo-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/seo-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/seo-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/seo-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/seo-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/seo-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/seo-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/seo-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/seo-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-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/seo-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-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/seo-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-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/seo-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/seo-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/seo-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/seo-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/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-overview/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-overview/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-overview/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-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-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/seo-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/seo-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-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/seo-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/seo-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-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/seo-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-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/seo-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-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/seo-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/seo-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/seo-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/seo-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/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-overview/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-overview/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-overview/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-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-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/seo-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/seo-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/seo-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore)\n\nSEO\n\nSearch Engine Optimization (SEO) is one of the most essential strategies for improving your site's visibility in organic search engine results. Well-optimized pages are more likely to appear in prominent positions on search engines, leading to higher traffic and better conversion rates.\n\n> Learn about best practices for improving your store SEO in the [SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo) guide.\n\nFastStore provides configuration options, such as editable meta tags (title, description, author, and templates), which help search engines understand and index your content. You can define these settings during the [project onboarding](#setting-seo-during-the-project-onboarding) or [updated later](#managing-seo-for-plps-and-pdps) in the `discovery.config.js` file.\n\n## Setting SEO during the project onboarding\n\nWhen [starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project), you should configure your website's SEO tags by setting values for the **Title Tag**, **Description Tag**, **Title Template**, and **Site Author**. These tags are part of your site's optimization strategy.\n\n\n\n### Default SEO settings\n\nThe default SEO values are defined in the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file of your store. When you configure these settings in WebOps during the onboarding process, this file is automatically updated. Example:\n\n`1\n\n seo: { \n\n2\n\n title: 'FastStore Starter', \n\n3\n\n description: 'Fast Demo Store', \n\n4\n\n titleTemplate: '%s | FastStore', \n\n5\n\n author: 'Store Framework', \n\n6\n\n }, \n\n`\n\n## Managing SEO for PLPs and PDPs\n\nAfter completing the onboarding process, you can update the SEO settings using the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options). In this file, you can update the title and description templates for both Product Listing Pages (PLPs) and Product Detail Pages (PDPs). For detailed instructions, see the [Configuring SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp) guide.\n\nAdditionally, you can improve performance and SEO by controlling lazy loading for custom sections. Learn more in [Optimizing SEO by managing lazy loading on PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp).\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/seo/overview.mdx)\n\n[Improving store performance with Preact« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/managing-performance-improving-store-performance-with-preact)[Configuring SEO for PLPs and PDPsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Setting SEO during the project onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-overview%23setting-seo-during-the-project-onboarding)\n\n[Default SEO settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-overview%23default-seo-settings)\n\n[Managing SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-overview%23managing-seo-for-plps-and-pdps)\n\nWas this helpful?\n\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/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Setting SEO during the project onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-overview%23setting-seo-during-the-project-onboarding)\n\n[Default SEO settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-overview%23default-seo-settings)\n\n[Managing SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-overview%23managing-seo-for-plps-and-pdps)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b649f34d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faq erp integration in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides)\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-guide)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration)\n\nFAQ: ERP Integration\n\n## 1\\. How should you treat order cancelations in the integration?\n\nWhen filtering Feed or Hook events by status, you can monitor events with the status `cancelation-request`. This way, whenever a customer requests cancelation the integration is notified and the store can check if the order is already on its way to the carrier or can still be canceled.\n\nVTEX’s [order flow](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/order-flow-on-the-oms--tutorials%5F196%23) includes a `window-to-cancel`, which is a time period you can set during which the order has not yet gone to handling and the customer may cancel with minimal consequence to the store.\n\nYou can also set up your integration to check again and see if the order has been canceled before it goes to shipping. At this point, if it has not been canceled, the store can invoice and ship it.\n\n## 2\\. Why doesn't the feed always return all available messages in the queue?\n\nThis is because of VTEX’s distributed data structure which allows different processes to run in parallel providing a high-performance system. For performance reasons, we use [Standard Queues at AWS’s Simple Queue Services](https://read.calvincode.net/reader?url=https://aws.amazon.com/pt/sqs/features/).\n\n## 3\\. Why does the feed send out duplicate events?\n\nThis can happen because of VETX’s distributed data structure which allows different processes to run in parallel providing a high-performance system.\n\nAlso, there are cases in which an order can receive the same status twice in regards to different events. Consider, for instance, an order that is split between two sellers of a marketplace. Each seller is going to invoice part of the order, generating two different events with the status `invoiced`. In cases like this, the integration must be prepared to deal with this possibility.\n\n## 4\\. Feed or Hook, which should I use?\n\nSee our [Feed v3 API guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed).\n\n## 5\\. Order is locked in `Ready for Handling`. What do I do?\n\nAccess our this [article on how to solve orders locked in Ready for Handling](https://read.calvincode.net/reader?url=https://help.vtex.com/faq/meus-pedidos-estao-travados-em-pronto-para-manuseio--frequentlyAskedQuestions%5F771%23).\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/erp-integration-guide/faq-erp-integration.md)\n\n[Update or delete information« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration//docs/guides/erp-integration-updating-and-deleting-information)[Customer CreditNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration//docs/guides/customer-credit-integration-guide)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[1\\. How should you treat order cancelations in the integration?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%231-how-should-you-treat-order-cancelations-in-the-integration)\n\n[2\\. Why doesn't the feed always return all available messages in the queue?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%232-why-doesnt-the-feed-always-return-all-available-messages-in-the-queue)\n\n[3\\. Why does the feed send out duplicate events?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%233-why-does-the-feed-send-out-duplicate-events)\n\n[4\\. Feed or Hook, which should I use?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%234-feed-or-hook-which-should-i-use)\n\n[5\\. Order is locked in Ready for Handling. What do I do?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%235-order-is-locked-in-ready-for-handling-what-do-i-do)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/faq-erp-integration.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[1\\. How should you treat order cancelations in the integration?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%231-how-should-you-treat-order-cancelations-in-the-integration)\n\n[2\\. Why doesn't the feed always return all available messages in the queue?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%232-why-doesnt-the-feed-always-return-all-available-messages-in-the-queue)\n\n[3\\. Why does the feed send out duplicate events?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%233-why-does-the-feed-send-out-duplicate-events)\n\n[4\\. Feed or Hook, which should I use?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%234-feed-or-hook-which-should-i-use)\n\n[5\\. Order is locked in Ready for Handling. What do I do?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%235-order-is-locked-in-ready-for-handling-what-do-i-do)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_900cc598
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore getting started 4 understanding the project structure in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-overview)\n\n4\\. Understanding the project structure\n\nLearn how the FastStore project is organized, including its main directories, configurations, and code architecture.\n\nIn this step, you'll learn how a FastStore project is organized and why it matters. Understanding the folder layout and key files helps you navigate the codebase, make targeted changes, and avoid misconfigurations as you customize your store.\n\nHere's the structure that represents the source code of a FastStore project:\n\n`1\n\n/ \n\n2\n\n|-- /.faststore \n\n3\n\n|-- /src \n\n4\n\n |-- /themes \n\n5\n\n |-- custom-theme.scss \n\n6\n\n|-- cypress.config.ts \n\n7\n\n|-- discovery.config.js \n\n8\n\n|-- next-env.d.ts \n\n9\n\n|-- package.json \n\n10\n\n|-- README.md \n\n11\n\n|-- tsconfig.json \n\n12\n\n|-- vercel.json \n\n13\n\n|-- vtex.env \n\n14\n\n|-- yarn.lock \n\n`\n\n## Folders\n\n* `/.faststore` \\- Manages and coordinates the FastStore project to deliver a functional starter store. This folder, also known as [@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson), provides the core functionality of the FastStore starter.\n* `/src` \\- Contains all of your store's customizations, including your custom components and theme.\n* [/themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview%23available-themes) \\- Keeps your store's theme, such as [midnight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-midnight).\n\n## Files\n\n* `custom-theme.scss` \\- Holds the styling information for your store, controlling the graphic elements such as typography, colors, borders, and spacing that give your store with a unique look and feel.\n* `cypress.config.ts` \\- Configures the options and preferences required for running tests with Cypress.\n* [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) \\- Configures aspects of the project such as SEO preferences, VTEX account options, and theme. Note that these configurations are set during the [onboarding process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project), reducing the need for changes to this file. For more information on configuration options for this file, refer to [Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options).\n* `next-env.d.ts` \\- Generates a TypeScript definition file for Next.js.\n* `tsconfig.json` \\- Configures the compiler options and project settings for TypeScript, including target version, module resolution, and source file locations.\n* `vtex.env` \\- Stores public environment variables that your application can access during runtime. These include flags like `SITE_HOST` (specifying the store's domain in production) and other publicly accessible values, including feature flags, URLs, and Analytics public tracking IDs. For private environment variables such as API keys and database credentials, use [VTEX secrets](https://read.calvincode.net/reader?url=https://v1.faststore.dev/how-to-guides/webops/security/setting-up-secrets).\n* `yarn.lock` \\- Locks down the exact versions of your project's dependencies, including transitive dependencies, to ensure consistent builds across different machines and environments. This file is automatically generated based on the dependencies in your `package.json` file.\n\n## `package.json`\n\nDefines the project metadata and manages dependencies and scripts with [Yarn](https://read.calvincode.net/reader?url=https://yarnpkg.com/migration/overview). Key packages include:\n\n### `@faststore/core`\n\nBundles FastStore source code, including the starter store. It contains four sub-packages: `components`, `sdk`, `ui`, and `api`.\n\n### `@faststore/sdk`\n\nHandles all meaningful states an ecommerce store might have, such as:\n\n| SDK states | Description |\n| ------------- | ------------------------------------------------------------------------------ |\n| **Session** | Handles auth, region, locale, and currency data. |\n| **Cart** | Handles a store cart's addition, remotion, update, and current state. |\n| **Component** | Handles the state of the components of a store (e.g., display/hide mini cart). |\n| **Search** | Handles the state of the faceted search (e.g., apply filters and sort). |\n\nThe SDKs also provide GA4-compatible analytics functions to help you create powerful analytics capabilities in your ecommerce.\n\n### `@faststore/ui`\n\nProvides the design system used by FastStore components, using [Sass](https://read.calvincode.net/reader?url=https://sass-lang.com/) for styling. For more information, refer to the [FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index) guide.\n\n> Although the components use [Sass](https://read.calvincode.net/reader?url=https://sass-lang.com/), you can style them using the desired tool for styling.\n\n### `@faststore/api`\n\nConnects your project to your favorite ecommerce provider by creating interfaces for querying products, collections, and handling carts.\n\n### `@faststore/cli`\n\nProvides scripts for building, running, debugging, and deploying your FastStore project. This package helps with debugging and differentiating between VTEX code and customizations. To learn more, refer to the [FastStore CLI documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli).\n\n---\n\n## Next step\n\nNow that you understand your project structure, connect it to Headless CMS for content management: [5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/4-understanding-the-project-structure.mdx)\n\n[3\\. Running the project locally« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-3-running-the-project-locally)[5\\. Integrating your project with the Headless CMSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Folders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23folders)\n\n[Files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23files)\n\n[package.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23packagejson)\n\n[@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststorecore)[@faststore/sdk](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoresdk)[@faststore/ui](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoreui)[@faststore/api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoreapi)[@faststore/cli](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststorecli)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23next-step)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/4-understanding-the-project-structure.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Folders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23folders)\n\n[Files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23files)\n\n[package.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23packagejson)\n\n[@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststorecore)[@faststore/sdk](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoresdk)[@faststore/ui](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoreui)[@faststore/api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoreapi)[@faststore/cli](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststorecli)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23next-step)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_54b88fd8
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides managing ssl certificates in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n[Managing SSL Certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates)\n\n[Implementing Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/implementing-mtls)\n\n[Revoking SSL private certificates when using Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/revoking-ssl-private-certificates-when-using-mtls)\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n[Managing SSL Certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates)\n\n[Implementing Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/implementing-mtls)\n\n[Revoking SSL private certificates when using Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/revoking-ssl-private-certificates-when-using-mtls)\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides)\n\nVTEX Shield\n\n[Managing SSL Certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates)\n\nManaging SSL certificates\n\nLearn how to manage custom SSL certificates with VTEX Shield.\n\n> This feature is part of [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you're a current VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you're not a customer yet but are interested in this solution, please complete our [contact form](https://read.calvincode.net/reader?url=https://vtex.com/en-us/contact/).\n\nVTEX automatically manages SSL certificates for stores by default, but merchants may need to use their own certificates for specific compliance reasons, internal security requirements, or certification entities that offer additional warranties.\n\nTo give them a flexible and secure way to upload their certificates to our infrastructure, we offer the [SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api) and the [SSL certificates](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/custom-ssl-certificates--1hoaDEbU50PDZSe6AYep9q) page in the Admin.\n\nThis guide explains how to use the API for managing certificates.\n\nThe SSL Certificates API allows users to list their custom SSL certificates, get a specific certificate by ID, and install or renew a certificate.\n\n## Before you begin\n\nMake sure you meet the following prerequisites to manage SSL certificates:\n\n* You must have the [Custom SSL certificates](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/custom-ssl-certificates--1hoaDEbU50PDZSe6AYep9q) feature from [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh).\n* You must have a user or API key associated with a [role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) that contains the following [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3): \n * **Product:** _CDN API_ \n * **Category:** _Certificate management_ \n * **Resources:** _Update certificate_ and _View certificate_\n\n## Installing or renewing an SSL certificate\n\nTo install a certificate, you can send its information through an [Install or renew SSL certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23put-/api/edge/certificates) `PUT` request, using _multipart/form-data_ or _application/json_. The process of renewing a certificate is the same as the process of installing one.\n\n#### Request example - multipart/form-data\n\n`1\n\ncurl --request PUT 'https://{{accountName}}.vtexcommercestable.com.br/api/edge/certificates' \\ \n\n2\n\n--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}' \\ \n\n3\n\n--form 'Hosts=\"{{MY_HOST}}\"' \\ \n\n4\n\n--form 'Certificate=@\"{{CERTIFICATE_PATH}}\"' \\ \n\n5\n\n--form 'PrivateKey=@\"{{PRIVATE_KEY_PATH}}\"' \n\n`\n\nFor the example account `myaccountname` and host `mystore.com`, the request should look like this:\n\n`1\n\ncurl --request PUT 'https://myaccountname.vtexcommercestable.com.br/api/edge/certificates' \\ \n\n2\n\n--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}' \\ \n\n3\n\n--form 'Hosts=\"mystore.com\"' \\ \n\n4\n\n--form 'Certificate=@\"/path/to/certificate.crt\"' \\ \n\n5\n\n--form 'PrivateKey=@\"/path/to/private.key\"' \n\n`\n\n#### Request example - application/json\n\n`1\n\ncurl --request PUT 'https://{{accountName}}.vtexcommercestable.com.br/api/edge/certificates' \\ \n\n2\n\n--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}' \\ \n\n3\n\n--header 'Content-Type: application/json' \\ \n\n4\n\n--data '{ \n\n5\n\n \"hosts\": [\"{{MY_HOST}}\"], \n\n6\n\n \"certificate\": \"{{BASE64_ENCODED_CERTIFICATE}}\", \n\n7\n\n \"privateKey\": \"{{BASE64_ENCODED_PRIVATE_KEY}}\" \n\n8\n\n}' \n\n`\n\nFor the example account `myaccountname` and host `mystore.com`, the request should look like this:\n\n`1\n\ncurl --request PUT 'https://myaccountname.vtexcommercestable.com.br/api/edge/certificates' \\ \n\n2\n\n--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}' \\ \n\n3\n\n--header 'Content-Type: application/json' \\ \n\n4\n\n--data '{ \n\n5\n\n \"hosts\": [\"mystore.com\"], \n\n6\n\n \"certificate\": \"LS0tLS1CRUd...S0tLS0K\", \n\n7\n\n \"privateKey\": \"LS0tLS1CRUd...LS0NCg==\" \n\n8\n\n}' \n\n`\n\n### Response example\n\nIn both cases, whether installing or renewing a certificate, the response should look like this:\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"id\": \"3421b2ea-94b1-55ac-67ea-e517018fbatc\", \n\n4\n\n \"account\": \"myaccountname\", \n\n5\n\n \"host\": \"mystore.com\", \n\n6\n\n \"serialNumber\": \"99C468B5853EF5549E40A44526720C71GT\", \n\n7\n\n \"subjectDistinguishedName\": \"CN=mystore.com\", \n\n8\n\n \"subjectCommonName\": \"mystore.com\", \n\n9\n\n \"subjectOrganization\": null, \n\n10\n\n \"issuerDistinguishedName\": \"CN=ZeroSSL RSA Domain Secure Site CA, O=ZeroSSL, C=AT\", \n\n11\n\n \"issuerCommonName\": \"ZeroSSL RSA Domain Secure Site CA\", \n\n12\n\n \"issuerOrganization\": \"ZeroSSL\", \n\n13\n\n \"installDate\": \"2025-04-24T20:15:51.7903622Z\", \n\n14\n\n \"startDate\": \"2025-03-20T00:00:00Z\", \n\n15\n\n \"expiryDate\": \"2025-06-18T23:59:59Z\", \n\n16\n\n \"signatureAlgorithm\": \"sha384RSA\", \n\n17\n\n \"x509Version\": \"3\", \n\n18\n\n \"installedBy\": \"22b312e1-f863-43t7-8c59-5n2f9ll0d09x\", \n\n19\n\n \"createdAt\": \"2025-03-20T13:20:34.40938Z\", \n\n20\n\n \"updatedAt\": \"2025-04-24T20:15:51.7903892Z\", \n\n21\n\n \"status\": \"Installing\" \n\n22\n\n } \n\n23\n\n] \n\n`\n\n> Find more details about each field in the [Install or renew SSL certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23put-/api/edge/certificates) `PUT` reference.\n\n## Listing SSL certificates\n\nYou can list your certificates with the [List SSL certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23get-/api/edge/certificates) `GET` endpoint, as shown below. Remember to replace the `accountName` and `VtexIdclientAutCookie` placeholders.\n\n### Request example\n\n`1\n\ncurl 'https://{{accountName}}.vtexcommercestable.com.br/api/edge/certificates' \\ \n\n2\n\n--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}' \n\n`\n\nFor the example account `myaccountname`, the request should look like this:\n\n`1\n\ncurl 'https://myaccountname.vtexcommercestable.com.br/api/edge/certificates' \\ \n\n2\n\n--header 'VtexIdclientAutCookie: 1234' \n\n`\n\n### Response example\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"id\": \"8c66122e-85cd-4bff-885d-aa9846e97541\", \n\n4\n\n \"account\": \"myaccountname\", \n\n5\n\n \"host\": \"mystore.com\", \n\n6\n\n \"serialNumber\": \"05C51F848EDBAC18E91D9AE43D8F6728D4F8\", \n\n7\n\n \"subjectDistinguishedName\": \"CN=mystore.com\", \n\n8\n\n \"subjectCommonName\": \"mystore.com\", \n\n9\n\n \"subjectOrganization\": null, \n\n10\n\n \"issuerDistinguishedName\": \"CN=R10, O=Let's Encrypt, C=US\", \n\n11\n\n \"issuerCommonName\": \"R10\", \n\n12\n\n \"issuerOrganization\": \"Let's Encrypt\", \n\n13\n\n \"installDate\": \"2025-04-22T16:24:58.768939Z\", \n\n14\n\n \"startDate\": \"2024-08-29T01:43:25Z\", \n\n15\n\n \"expiryDate\": \"2024-11-27T01:43:24Z\", \n\n16\n\n \"signatureAlgorithm\": \"sha256RSA\", \n\n17\n\n \"x509Version\": \"3\", \n\n18\n\n \"installedBy\": \"22b312e1-f863-43t7-8c59-5n2f9ll0d09x\", \n\n19\n\n \"createdAt\": \"2024-10-25T17:51:51.222052Z\", \n\n20\n\n \"updatedAt\": \"2025-04-22T16:24:58.768939Z\", \n\n21\n\n \"status\": \"Active\" \n\n22\n\n } \n\n23\n\n] \n\n`\n\n> Find more details about each field in the [List SSL certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23get-/api/edge/certificates) `GET` reference.\n\n## Getting an SSL certificate by its ID\n\nTo get a specific certificate, you can use the [Get SSL certificate by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23get-/api/edge/certificates/-certificateId-) `GET` request. Remember to replace the `accountName` and `VtexIdclientAutCookie` placeholders.\n\n### Request example\n\n`1\n\ncurl 'https://{{accountName}}.vtexcommercestable.com.br/api/edge/certificates/{{certificateId}}' \\ \n\n2\n\n--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}' \n\n`\n\nFor the example account `myaccountname` and certificate ID `8c66122e-85cd-4bff-885d-aa9846e97541`, the request should look like this:\n\n`1\n\ncurl 'https://myaccountname.vtexcommercestable.com.br/api/edge/certificates/8c66122e-85cd-4bff-885d-aa9846e97541' \\ \n\n2\n\n--header 'VtexIdclientAutCookie: 1234' \n\n`\n\n### Response example\n\n`1\n\n{ \n\n2\n\n \"id\": \"8c66122e-85cd-4bff-885d-aa9846e97541\", \n\n3\n\n \"account\": \"myaccountname\", \n\n4\n\n \"host\": \"mystore.com\", \n\n5\n\n \"serialNumber\": \"05C51F848EDBAC18E91D9AE43D8F6728D4F8\", \n\n6\n\n \"subjectDistinguishedName\": \"CN=mystore.com\", \n\n7\n\n \"subjectCommonName\": \"mystore.com\", \n\n8\n\n \"subjectOrganization\": null, \n\n9\n\n \"issuerDistinguishedName\": \"CN=R10, O=Let's Encrypt, C=US\", \n\n10\n\n \"issuerCommonName\": \"R10\", \n\n11\n\n \"issuerOrganization\": \"Let's Encrypt\", \n\n12\n\n \"installDate\": \"2025-04-22T16:24:58.768939Z\", \n\n13\n\n \"startDate\": \"2024-08-29T01:43:25Z\", \n\n14\n\n \"expiryDate\": \"2024-11-27T01:43:24Z\", \n\n15\n\n \"signatureAlgorithm\": \"sha256RSA\", \n\n16\n\n \"x509Version\": \"3\", \n\n17\n\n \"installedBy\": \"22b312e1-f863-43t7-8c59-5n2f9ll0d09x\", \n\n18\n\n \"createdAt\": \"2024-10-25T17:51:51.222052Z\", \n\n19\n\n \"updatedAt\": \"2025-04-22T16:24:58.768939Z\", \n\n20\n\n \"status\": \"Active\" \n\n21\n\n} \n\n`\n\n> Find more details about each field in the [Get SSL certificate by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23get-/api/edge/certificates/-certificateId-) `GET` reference.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Shield/managing-ssl-certificates.md)\n\n[Sessions System Overview« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates//docs/guides/sessions-system-overview)[Implementing Mutual Transport Layer Security (mTLS)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates//docs/guides/implementing-mtls)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23before-you-begin)\n\n[Installing or renewing an SSL certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23installing-or-renewing-an-ssl-certificate)\n\n[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-example)\n\n[Listing SSL certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23listing-ssl-certificates)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-example)\n\n[Getting an SSL certificate by its ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23getting-an-ssl-certificate-by-its-id)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-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/VTEX Shield/managing-ssl-certificates.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23before-you-begin)\n\n[Installing or renewing an SSL certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23installing-or-renewing-an-ssl-certificate)\n\n[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-example)\n\n[Listing SSL certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23listing-ssl-certificates)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-example)\n\n[Getting an SSL certificate by its ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23getting-an-ssl-certificate-by-its-id)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-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_a159cf49
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides sent offers integration guide connectors in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/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/sent-offers-integration-guide-connectors/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors)\n\n[Offer Management SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/offer-management-sdk)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/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/sent-offers-integration-guide-connectors/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/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/sent-offers-integration-guide-connectors/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/sent-offers-integration-guide-connectors/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/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/sent-offers-integration-guide-connectors/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors)\n\n[Offer Management SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/offer-management-sdk)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/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/sent-offers-integration-guide-connectors/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/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/sent-offers-integration-guide-connectors/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/sent-offers-integration-guide-connectors/docs/guides)\n\nIntegration Guides\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors)\n\nOffer Management integration guide\n\nLearn how to use Offer Management to improve the seller's visibility of the product's sending process to external channels.\n\n> The Offer Management module has been discontinued and is no longer supported. The module has been replaced by [Offer Status](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/status-de-anuncios-beta--2OE87wU26F7lApl99OdwvJ). To learn more, visit the [announcement](https://read.calvincode.net/reader?url=https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\n\nOffer Management is the VTEX feature that gives sellers more visibility around a product’s sending process to external channels, like marketplaces. Offer Management does not reflect what happens to offers after they’re sent to channels and start being sold. Instead, it helps sellers identify updates and solve errors in their offers during the sending process, guaranteeing that they can be sent to the marketplace and synced correctly.\n\nConnectors are responsible for integrating marketplaces to Offer Management, so that sellers can have updated information about their offers, and solve any errors around them.\n\n**This documentation is a guide for connectors to integrate with Offer Management, and become an available channel for sellers to track their offers with.**\n\nConnectors interact with Offer Management in four ways:\n\n1. [Creating channel](#1-create-channel).\n2. [Activating feed](#2-feed-establishing-the-connection).\n3. [Updating offers](#3-interactions-where-all-processes-happen), by creating interactions.\n4. [Registering all actions in the Offer Management timeline](#4-logs-registering-steps), by creating logs.\n\n> **VTEX Bridge** was the previous VTEX module responsible for managing all marketplaces used by a seller. Offer Management replaces the product, price, and inventory features currently managed by VTEX Bridge.\n\nThe diagram below shows the Offer Management’s interface, which the vendors access through their VTEX accounts.\n\n\n\n## 1\\. Create Channel\n\n> **API Reference:** [Create Channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/channels)\n\nThe first step for connectors to integrate with Offer Management is to create a channel, that represents the marketplace to where sellers will send their offers.\n\nThe [Create Channel API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/channels) must be called a single time by the connector for each marketplace. The feedId created by this call will apply to all sellers connected to the given channel, and will be necessary for the next step of the integration flow.\n\n> Note that creating the channel through API is a sensitive step, and does not include public endpoints for retrieving (`GET`), updating (`PUT`), or deleting (`DELETE`) the channel created. If you wish to make any changes of this sort, you can request it through a [support](https://read.calvincode.net/reader?url=https://help.vtex.com/support?/cultureInfo=en-us) ticket with VTEX.\n\n## 2\\. Feed: establishing the connection\n\n> **API Reference:** [Activate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds)\n\nAfter you have [created the channel](#1-create-channel) in Offer Management, the connection between seller and marketplace can be established, through the feed. The channels available for connecting with Offer Management are:\n\n* Mercado Livre Classic\n* Mercado Livre Premium\n* Netshoes\n* VTEX marketplaces\n\nThe feed links the created channel to a seller’s account, so offers and their data can be exchanged. When a connector calls the [Activate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds) API, it establishes the relation between a seller and the channel. This endpoint should only be used once, to activate the channel and establish the connection. However, If a feed is [deactivated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23delete-/api/sent-offers/feeds/-feedId-), it can be reactivated for that channel by another call to the Activate Feed API.\n\n### Managing the Feed ID\n\nThe `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. This means that a feed’s `feedId` is always the same for the relation between those specific sellers and channels, and will be used in other API calls. Connectors can create more than one feed with a single marketplace, depending on their business rules. It doesn’t matter if a feed is established more than once, the ID is always the same, and each connector is aware of the ID implemented.\n\nThe pattern for naming the `feedId` is the following: `“seller” + “.” + “channel’s name”`\n\nEx., “vtex.netshoes”, “anymarket.b2w”, `\"vtex.meli-premium\"`, `\"vtex.meli-classic\"`, “vtex.wish”.\n\n## 3\\. Interactions: where all processes happen\n\n> **API Reference:** [Open Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), [Close Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/close)\n\nBoth the Marketplace and the seller operate everything that happens to offers by creating interactions. For every action that happens to an offer, the connector must create an interaction to notify it. The image below shows how interactions appear on the Offer Management's UI.\n\n\n\n### Interaction Lifecycle\n\nAn interaction is the space where a process around an offer and all the actions within it are recorded. It’s lifecycle is the following:\n\n1. **Open interaction:** connectors [open an interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions) to begin adding a process to an offer.\n2. **Create logs:** while open, connectors include in that interaction all the steps that happened to make it come to life, by adding [logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs).\n3. **Close interaction:** the connector [closes the interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/close), once the process it was trying to accomplish is concluded and there are no more events taking place within it.\n\n### Interaction Origins\n\nA seller interaction’s `origin` indicates what the process is about, and includes the following categories:\n\n* Catalog\n* Price\n* Inventory\n\n\n\nInteractions are usually used to deal with a single type of process at a time. However, there are situations in which data about catalog, price or inventory are added in the same interaction. \n\n> Ex., B2W’s API has only one endpoint for creating and updating products. This means that to send them a seller’s catalog, both price and inventory data must be sent through the request. So even though initially an `Inventory type` interaction is created, price data will also be added.\n\n### Offers Status\n\nThe seller’s goal is to send and sync all their offers on a channel. In this process, **offers** can have the following statuses:\n\n* **Synced:** when offers are successfully sent to a channel and are currently being synced between both entities.\n* **Sending:** intermediate state, when offers are still in the process of being sent to a channel. This status involves offers that are either sent for the first time to the marketplace, migrated to a new marketplace, or resent offers that were once deleted from a channel.\n* **Error:** when Offer Management finds an error that prevents sending or updating an offer to a channel. Therefore this status requires manual correction.\n* **Disabled:** when the offer is discarded by the connector, by being inactive or not included in the trade policy.\n\n### Result Status\n\nAn interaction’s goal is to generate a process, or update to an offer. Once an interaction is closed, the combination of steps that constitute it produce a `result`, that summarizes the outcome of the interaction. Interaction **results** include:\n\n* **Success:** When events close their lifecycle successfully, and generate updates on an offer in terms of price, inventory, or catalog.\n* **Failure:** When the connector has detected processes that have failed to be made due to an error.\n* **Notification:** When there are processes with the connector that are worth mentioning, but there are no actual updates.\n\n> Ex: discarded updates or sendings of an offer.\n\n* **Processing:** When an open interaction hasn’t been concluded, and should still receive more steps. This is a transitory state, considering that when an interaction is closed, it can only end with `success`, `failure` or `notification` as its result.\n\nThis result is what allows Offer Management to infer an offer’s status. The types of interaction results, and their relation to offer statuses are the following:\n\n| Interaction result | Status | Description |\n| ------------------ | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Success** | **Synced** | When closing a success interaction, Offer Management updates the offer’s status to Synced, if there aren't any active errors in this offer. |\n| **Success** | **Unavailable** | When the offer already exists and the seller removes it from the trade policy, Offer Management doesn’t infer an offer’s status. |\n| **Failure** | **Error** | When an offer has at least one failure interaction, the offer’s status becomes error. |\n| **Notification** | **Unavailable** | When the offer is discarded by the connector - by being inactive or not included in the trade policy, Offer Management doesn’t infer an offer’s status, and the connector indicates it. In that case, the connector will send the \"status\":\"unavailable\" data in an interaction. |\n| **Processing** | **Sending** | When the interaction is being processed, the offer’s status becomes sending when the interaction has the attribute “context”=”setup”. |\n\n## 4\\. Logs: registering steps\n\n> **API Reference:** [Create Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs)\n\nLogs are the granular details of actions that happen within an interaction, organized in a timeline. They are the way an interaction is made visible in Sent Offer’s UI. All micro steps that go through an interaction will be represented through logs.\n\n### Log Types\n\nConnectors are responsible for attributing the correct type for each log. Therefore, be mindful of their correct usage, by following the descriptions below:\n\n* **Success:** only logs that conclude an interaction’s goal should be `“type”=”success”`._Ex. concluded updates in price, inventory, offer ID, or catalog._\n* **Information:** logs that expose the actions of an update process, to provide visibility and contribute with more technical investigations. Info logs may include internal processes of a system (`agent` attribute), or calls between two systems._Ex. Placing an offer in the queue, indicating that an offer is being processed, indicating that a call to Catalog has been made, adding requests and responses as evidences, etc._\n* **Warning:** logs used in cases where the communication between two systems fails, and there are no actions that the user can take to fix it. They are usually cases where the connector should perform a retry, and provide visibility of what is being attempted again._Ex. Throttling, service unavailable, etc._\n* **Failure:** logs noticed by the connector as errors that prevent an offer from being correctly sent and synced to a channel. They will be described in more detail in the following section._Ex. Product descriptions that exceed the character limit, product’s image with low quality, etc._\n\n## 5\\. Actions performed by creating interactions and logs\n\n### Sending offers to the marketplace\n\n> **API Reference:** [Activate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds), [Open Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), [Create Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs), [Close Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/close)\n\nConnectors are the agents responsible for sending the seller’s products to their channels. They do that by creating events, since that is the mechanism for reporting all interactions around offers. Consider the following example, in which a seller wants to integrate with Mercado Livre:\n\n1. Activate the **Feed**.\n2. Open **Interaction**.\n3. Create **Log**._In that log, connectors indicate the series of actions that took place for the offers to be created._\n4. Call **Catalog** API._One of the logs shows that connectors called the Catalog API to identify the SKUs that were present in the Mercado Livre trade policy, and try to send their offers to that channel. As long as that analysis happens, the offer’s status is `sending`._ _SKUs that are identified as being a part of Mercado Livre’s trade policy are sent to the channel. - All SKUs that don’t belong to that trade policy are discarded, and kept in the Discarded Offers page, in the UI._\n5. Create **Log.** _Once this analysis process is over, and the connector has identified which SKUs belong to the channel, and which can be discarded, the connector can create the last log of that event, indicating success or failure._ _It is important to point out that whenever a Catalog log is created, Offer Management evaluates if that offer already exists in its base. If it’s the first load of products, or if a new product is added, the `context` field’s value is `setup`._\n6. Close **Interaction**.\n\n### Updating offers through Interactions\n\n> **API Reference:** [Open Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), [Create Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs), [Close Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/close)\n\n**Updates from sellers:** Sellers notify the marketplace of all changes that come from their side, by creating interactions. These are the types of changes that come from sellers:\n\n* Product information, from the Catalog.\n* Price value.\n* Inventory level.\n\n**Updates from Marketplaces:** The Marketplace notifies Offer Management about all changes originating from its side. These are the changes that come from marketplaces:\n\n* Changes in the Offer ID from the Marketplace’s side.\n* Errors detected.\n\n### Pointing out errors in offers\n\n> **API Reference:** [Create Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs), [Search Errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23get-/api/sent-offers/search/errors)\n\nIt is the connector's responsibility to identify errors that prevent an offer from being sent to a marketplace. This log allows the connector to notify the Offer Management that an error has occurred. Connectors point out problems with an offer by creating failure logs. From the information sent through the `errors` attribute, sellers can identify and fix errors on their offers.\n\nConnectors must identify all errors, and send them all in a single request. This means that connectors should go through every possible validation, and only after all errors are identified, create the failure log.\n\n#### Error codes\n\nThe Offer Management owns the intelligence by recognizing most of the problems that happen between VTEX, connectors and channels. This way, through a code, a connector will be able to identify pre-defined classifications and solving actions for their errors and easily leverage from it without needing development from their end. All the attributes of a code are filled and maintained by Offer Management. The Offer Management will create, update and delete codes in order to always keep an updated list for connectors leveraging from it.\n\nThe **Search Errors** endpoint returns the updated list of error codes. It is the only source of truth about the codes and where they will be always updated.\n\n#### External code\n\nConnectors must extend the Offer Management' codes by adding their own code IDs for mapping specific scenarios that apply to their own system. They can send those codes through a suffix ID added in an existing code. This way the Offer Management knows which errors must be archived and which errors must be kept, being able to classify that given error and improve its solving action. These suffix IDs are totally managed by the connectors, which will require them a way to map each error inside their own code.\n\nThe format for adding external codes should be:\n\n`internalCode` \\+ `connectorCode`\n\nEx: let's say the Offer Management code for errors in the description field is `CTLG-005`. On Marketplace A, it is not allowed to use HTML on the description, and to use more than 4000 characters. On Marketplace B it is not allowed to use more than 5000 characters.\n\nSo Marketplace A’s connector would insert errors of description with HTML extending the original code like this: `CTLG-005-001`. And the character one could be `CTLG-005-002`. While Marketplace B’s connector could insert `CTLG-005-001`.\n\n#### Unmapped errors\n\nIt is expected that errors that haven’t been mapped by Offer Management, and aren’t yet on the error’s code list, may appear. Follow the practices below to identify and deal with them:\n\n* **Unmapped error’s code:** for those scenarios, the Offer Management created the following error code: `NTMAP-001`. This code should be used by the connector when they don’t recognize the error received.\n* **Identifying unmapped errors:** in this case, we recommend using the hash method to map these errors. Ideally, this method should be used when the error’s description doesn’t present variables. Thus it will be possible to monitor and verify which unmapped errors are occurring more frequently, so they are later codified. It is a cyclical process, where the connector provides new data so that the Offer Management can improve its error mapping.\n* **Adding evidence to unmapped errors:** unmapped errors still need evidences in their logs so sellers understand the situation. We recommend sending the error detected by the channel’s API response in the `evidence` field.\n\n### Updating and deleting a Feed\n\n> **API Reference:** [Update Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23put-/api/sent-offers/feeds/-feedId-), [Deactivate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23delete-/api/sent-offers/feeds/-feedId-)\n\nUpdating a feed’s information is only possible through API calls. Only the trade policy and affiliate ID can be changed. When a channel integration is uninstalled by the seller, the connector must delete the feed in Offer Management as well. That way, that channel won’t appear in the UI. This action is done by the Delete Feed endpoint.\n\nNote that once the feed is deleted, all offers’ data, errors and their logs will also be deleted from the UI. However, the source of truth around the products sent to the channel will still remain in the catalog, and log’s history will be preserved. If the channel integration is reinstalled, the whole process described in this guide must begin again, done from scratch. This means the connector will have to send all offers from the catalog to the channel again anyways.\n\n## API Reference\n\n* [Create Channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/channels)\n* [Activate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds)\n* [List Feeds](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23get-/api/sent-offers/feeds)\n* [Update Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23put-/api/sent-offers/feeds/-feedId-)\n* [Get Feed by feedId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23get-/api/sent-offers/feeds/-feedId-)\n* [Deactivate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23delete-/api/sent-offers/feeds/-feedId-)\n* [Open Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions)\n* [Get Interaction Data by interactionId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23get-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-)\n* [Close Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/close)\n* [Create Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs)\n* [Get Log Data by logId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23get-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs/-logId-)\n* [Search Interactions and their Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23get-/api/sent-offers/search/interactions)\n* [Search Errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23get-/api/sent-offers/search/errors)\n* [Get Error Code data by errorCodeId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management%23get-/api/sent-offers/error-codes/-errorCodeId-)\n\nContributors\n\n3\n\n[](https://github.com/anabaarbosa)\n\n[](https://github.com/carolinamenezes)\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/Integration-Guides/sent-offers-integration-guide-connectors.md)\n\n[Punchout login integration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors//docs/guides/punchout-login-integration)[Offer Management SDKNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors//docs/guides/offer-management-sdk)\n\nContributors\n\n3\n\n[](https://github.com/anabaarbosa)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/jumeyermattosarruda)\n\nON THIS PAGE\n\n[1\\. Create Channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%231-create-channel)\n\n[2\\. Feed: establishing the connection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%232-feed-establishing-the-connection)\n\n[Managing the Feed ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23managing-the-feed-id)\n\n[3\\. Interactions: where all processes happen](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%233-interactions-where-all-processes-happen)\n\n[Interaction Lifecycle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23interaction-lifecycle)[Interaction Origins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23interaction-origins)[Offers Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23offers-status)[Result Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23result-status)\n\n[4\\. Logs: registering steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%234-logs-registering-steps)\n\n[Log Types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23log-types)\n\n[5\\. Actions performed by creating interactions and logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%235-actions-performed-by-creating-interactions-and-logs)\n\n[Sending offers to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23sending-offers-to-the-marketplace)[Updating offers through Interactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23updating-offers-through-interactions)[Pointing out errors in offers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23pointing-out-errors-in-offers)[Updating and deleting a Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23updating-and-deleting-a-feed)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23api-reference)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/sent-offers-integration-guide-connectors.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[1\\. Create Channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%231-create-channel)\n\n[2\\. Feed: establishing the connection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%232-feed-establishing-the-connection)\n\n[Managing the Feed ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23managing-the-feed-id)\n\n[3\\. Interactions: where all processes happen](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%233-interactions-where-all-processes-happen)\n\n[Interaction Lifecycle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23interaction-lifecycle)[Interaction Origins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23interaction-origins)[Offers Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23offers-status)[Result Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23result-status)\n\n[4\\. Logs: registering steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%234-logs-registering-steps)\n\n[Log Types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23log-types)\n\n[5\\. Actions performed by creating interactions and logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%235-actions-performed-by-creating-interactions-and-logs)\n\n[Sending offers to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23sending-offers-to-the-marketplace)[Updating offers through Interactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23updating-offers-through-interactions)[Pointing out errors in offers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23pointing-out-errors-in-offers)[Updating and deleting a Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23updating-and-deleting-a-feed)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors/docs/guides/sent-offers-integration-guide-connectors%23api-reference)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4c480d9b
|
[
{
"role": "system",
"content": "You are a VTEX 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 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/payments-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/payments-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/payments-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/payments-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/payments-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/payments-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/payments-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-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/payments-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-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/payments-integration-guide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-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/payments-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-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/payments-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/payments-integration-guide/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide/docs/guides/payments-integration-guide)\n\nPayments\n\nCommunication between systems and services of stores, partners and platform is carried out through integration protocols. At VTEX, we use the Payment Provider Protocol (PPP), a protocol created to assist companies that carry out financial transaction operations.\n\nBefore continuing, make sure you are familiar with some terms that are frequently used in articles in this guide:\n\n* **Acquirer:** a company that specializes in payment processing. For more information, access [What is an acquirer?](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-acquirer--7N1oRTG8dGmOiIugC0cs4E).\n* **Merchant or Client:** an individual or business that holds its ecommerce or physical stores operations in the VTEX platform.\n* **Customer:** an individual or business that purchases a product or service from a VTEX client.\n* **Provider:** agent that will process the merchant's payments. It can be a payment system, payment provider, or a gateway.\n* **Partner:** agent responsible to carry out the integration between the provider and the VTEX platform.\n* **VTEX Payment Gateway:** VTEX system responsible for processing payments. The gateway communicates with the provider through the Payment Provider Protocol (PPP).\n* **Payment Service Provider (PSP):** financial entity that is authorized to process financial transactions between merchants, acquiring banks, and card networks. It is a fast and cost-effective way to accept payments without needing to open a company in another country or having to create a merchant account.\n* **Payload:** set of data sent in JSON format through a request body of an endpoint.\n* **Connector:** provider affiliation that acts as a bridge between the provider and the VTEX checkout.\n* **Oauth:** authorization protocol made for Application Programming Interfaces (APIs). It allows the provider system to access the customer data to process a payment transaction.\n\nThe articles listed below present the characteristics and mode of operation of our payment architecture, providing implementation information to allow you to integrate your payment service into VTEX or use the payment solutions already available.\n\n## Structure of this guide\n\n| Article | Description |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| [Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex) | A step-by-step guide to integrating your payment provider into VTEX. |\n| [Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol) | Overview of our integration protocol, the Payment Provider Protocol (PPP). |\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-ppp-applied-to-pos) | PPP information for use in physical stores. |\n| [Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider) | How to develop your middleware to communicate with the PPP. |\n| [Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework) | Overview of our alternative method of developing payment connectors through VTEX IO. |\n| [Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows) | Information on the types of payment flows available on VTEX. |\n| [Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app) | Overview of the Payment App and how to implement it in your store. |\n| [Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-methods) | Overview of payment methods accepted by VTEX. |\n| [Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation) | How to carry out the tests to request the approval of your payment connector. |\n| [Anti-fraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works) | Overview of our anti-fraud integration protocol, the Anti-fraud Provider Protocol. |\n| [PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance) | Information about the PCI-DSS certification and when it is required. |\n| [Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy) | Information about the VTEX solution for transferring sensitive data in an environment without the use of PCI - Dss certification. |\n| [Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/split-payouts-on-payment-provider-protocol) | Overview of our Split Payouts process on the PPP. |\n| [Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex) | How to develop a custom layout for your payment method. |\n| [Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature) | Information from the VTEX solution created to define a custom delay interval for automatically capturing payments. |\n| [Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil) | How to implement the PIX payment method in your store. |\n| [PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pse-payment-method) | How to implement the PSE payment method in your store. |\n| [Installing Affirm Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-affirm-payment-app-1) | How to implement the Affirm Payment App payment method in your store. |\n| [Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud) | How the Google Pay payment method is identified in transactions. |\n\n> ✔️ To integrate a payment solution in VTEX you must fill out the registration form to join our [Partner Program](https://read.calvincode.net/reader?url=https://vtex.com/us-en/partners) to get access to your own VTEX account. If you are already a client or partner, you can [open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) if you have any questions.\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide.md)\n\n[Offer Management SDK« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide//docs/guides/offer-management-sdk)[Integrating a new payment provider on VTEXNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide//docs/guides/integrating-a-new-payment-provider-on-vtex)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\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/payments-integration-guide/docs/guides/payments-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/payments-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/payments-integration-guide/docs/guides/payments-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_a62dbb3d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides rotating vtex api tokens in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/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/rotating-vtex-api-tokens/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/api-usage)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/authentication)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens)\n\nRotating VTEX API tokens\n\nLearn how to securely rotate VTEX API tokens to minimize security risks and ensure uninterrupted service.\n\nThe older API tokens are, the higher the risk of exposure and potential damage to your operations. To minimize vulnerabilities and ensure store security, we strongly recommend renewing tokens regularly, ideally before any renewal alert in the [API keys](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6) dashboard.\n\n> This guide explains how to renew VTEX API tokens using the [VTEX ID API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api). Alternatively, you can rotate tokens using the API keys Admin page. Learn more at [Renewing API tokens](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/renewing-api-tokens--7r4AzptYjXErGHadg9LnJ3).\n\nThe VTEX renewal process allows you to generate a new token while the old one remains active, ensuring uninterrupted service during the transition.\n\n> VTEX recommends renewing tokens every 90 or 180 days, based on the policies of your organization. Tokens don't expire automatically, so regular rotation is a proactive security best practice.\n\n## Token rotation process\n\nThe API-based token rotation process involves two steps, as illustrated in the diagram below:\n\n1. The system initiates the token renewal by calling the `PATCH` [Initiate token renewal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api%23patch-/api/vtexid/apikey/-apiKey-/apitoken/renew) endpoint. The API responds with a new token while keeping the old one active.\n2. After updating all systems to use the new token, the system calls the `PATCH` [Complete token renewal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api%23patch-/api/vtexid/apikey/-apiKey-/apitoken/finish-renewal) endpoint to deactivate the old token and complete the rotation.\n\nSystemVTEX APIStep 1 – Initiate renewalBoth tokens are now activeStep 2 – Complete renewalPATCH /apitoken/renew200 OK - Returns new tokenPATCH /apitoken/finish-renewal200 OK - Old token deactivatedSystemVTEX API\n\n## Required permission\n\nTo ensure security when renewing keys, these endpoints require authorization. You must use a valid API key (not the one being renewed) with access to the following License Manager resource:\n\n| Product | Category | Resource |\n| --------------- | ------------------ | ------------------- |\n| License Manager | API Key Management | **Renew API Token** |\n\n## Step 1 - Initiate token renewal\n\nUse the `PATCH` [Initiate token renewal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api%23patch-/api/vtexid/apikey/-apiKey-/apitoken/renew) endpoint to start the renewal process. This generates a new API token without deactivating the current one, allowing both to be used simultaneously during the transition period.\n\n### Request example\n\n`1\n\ncurl -X PATCH \"https://apiexamples.vtexcommercestable.com.br/api/vtexid/apikey/{apiKey}/apitoken/renew\" \\ \n\n2\n\n -H \"Content-Type: application/json\" \\ \n\n3\n\n -H \"X-VTEX-API-AppKey: {apiKey}\" \\ \n\n4\n\n -H \"X-VTEX-API-AppToken: {apiToken}\" \\ \n\n`\n\n### Response example\n\n`1\n\n{ \n\n2\n\n \"id\": \"1f6c17e5-06f9-44a9-a459-b3686e03fa9d\", \n\n3\n\n \"keyName\": \"my-api-key\", \n\n4\n\n \"creationDateToken\": \"2025-02-18T12:00:00Z\", \n\n5\n\n \"creationDateNewToken\": \"2025-02-25T12:00:00Z\", \n\n6\n\n \"expirationPeriod\": 30, \n\n7\n\n \"newToken\": \"abc123xyz789\" \n\n8\n\n} \n\n`\n\nThe response includes the new token (`newToken`), which is valid but not yet exclusive. You can now update your systems to use the new token.\n\n## Step 2 - Complete token renewal\n\nAfter you’ve updated all systems to use the new token, call the `PATCH` [Complete token renewal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api%23patch-/api/vtexid/apikey/-apiKey-/apitoken/finish-renewal) endpoint to complete the process. This step deactivates the old token, ensuring that only the new one remains valid.\n\n> Before completing the renewal, make sure that no integrations are still using the old token. This action is can't be undone.\n\n### Request example\n\n`1\n\ncurl -X PATCH \"https://apiexamples.vtexcommercestable.com.br/api/vtexid/apikey/my-api-key/apitoken/finish-renewal\" \\ \n\n2\n\n -H \"Content-Type: application/json\" \\ \n\n3\n\n -H \"X-VTEX-API-AppKey: {apiKey}\" \\ \n\n4\n\n -H \"X-VTEX-API-AppToken: {apiToken}\" \n\n`\n\n### Response example\n\n`1\n\n{ \n\n2\n\n \"id\": \"1f6c17e5-06f9-44a9-a459-b3686e03fa9d\", \n\n3\n\n \"creationDateToken\": \"2025-02-18T15:30:00Z\", \n\n4\n\n \"creationDateNewToken\": null \n\n5\n\n} \n\n`\n\nA `null` value in `creationDateNewToken` confirms that the old token is now deactivated and the rotation is complete.\n\n## Post-rotation checklist\n\nAfter completing the token rotation, make sure to follow the steps below to avoid disruptions and maintain security across all systems:\n\n* Update all environments and tools with the new token.\n* Remove the old token from vaults or environment variables.\n* Monitor logs for failed authentication attempts.\n* Inform affected teams or services about the token change.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/authentication/rotating-vtex-api-tokens.md)\n\n[API authentication using API keys« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens//docs/guides/api-authentication-using-api-keys)[App authentication using auth tokensNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens//docs/guides/app-authentication-using-auth-tokens)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Token rotation process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23token-rotation-process)\n\n[Required permission](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23required-permission)\n\n[Step 1 - Initiate token renewal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23step-1-initiate-token-renewal)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23response-example)\n\n[Step 2 - Complete token renewal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23step-2-complete-token-renewal)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23response-example)\n\n[Post-rotation checklist](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23post-rotation-checklist)\n\nWas this helpful?\n\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/rotating-vtex-api-tokens.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Token rotation process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23token-rotation-process)\n\n[Required permission](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23required-permission)\n\n[Step 1 - Initiate token renewal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23step-1-initiate-token-renewal)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23response-example)\n\n[Step 2 - Complete token renewal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23step-2-complete-token-renewal)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23response-example)\n\n[Post-rotation checklist](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rotating-vtex-api-tokens/docs/guides/rotating-vtex-api-tokens%23post-rotation-checklist)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d91f9dcb
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides api authentication using api keys in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/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/api-authentication-using-api-keys/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/api-usage)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/api-authentication-using-api-keys)\n\nAPI authentication using API keys\n\nApplication keys (`appKey`) are credentials used to authenticate requests to VTEX APIs. Store administrators can create multiple application keys that may be used, for example, for different integrations. Read [Generating and managing application keys](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6) to learn how to create these credentials.\n\nAn API key includes specific permissions, based on License Manager [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) and [resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) selected when creating or editing the API key. Read [Managing app key permissions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6%23managing-app-key-permissions) for more details.\n\nEach `appKey` you create has an associated `appToken`. The appKey-appToken pair can be used in API requests to authorize interactions with VTEX services if they have [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) with the required [resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3?%26utm%5Fsource=autocomplete).\n\nApplication keys are usually the best way to authenticate API calls in your integrations or in self-hosted backend requests in general. However, frontend requests should be authenticated with [user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens).\n\n> Do not use application keys in your client-side code. This makes your store vulnerable to attacks. Follow the [Best practices for using application keys](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm%23never-use-client-side-code-for-integrations).\n\n## Usage\n\nUse the `appKey` and `appToken` credential pair to authenticate API requests by sending their values in these HTTP headers:\n\n| Header key | Value |\n| ------------------- | ---------- |\n| X-VTEX-API-AppKey | {appKey} |\n| X-VTEX-API-AppToken | {appToken} |\n\nSee an example [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorder) request:\n\n`1\n\ncurl --location --request GET 'https://apiexamples.vtexcommercebeta.com.br/api/oms/pvt/orders/:orderId' \\ \n\n2\n\n--header 'X-VTEX-API-AppKey: vtexappkey-example-YSWQFZ' \\ \n\n3\n\n--header 'X-VTEX-API-AppToken: eyJhbGciOiJFUzI1NiIsImtpZCI6IjA1MTZFN0IwMDNFODMxRTg0QkFDOTg2NzBCNUM2QTRERTlBN0RFNkUiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwZWRyby5jb3N0YUB2dGV4LmNvbS5iciIsImFjY291bnQiOiJhcHBsaWFuY2V0aGVtZSIsImF1ZGllbmNlIjoiYWRtaW4iLCJzZXNzIjoiZjU3YjMyMGItMWE3YS00YzlkLWJkNDMtZTE4NDdhYmE1MTE1IiwiZXhwIjoxNjE2NzY3Mjc4LCJ1c2VySWQiOiJmYjU0MmU1MS01NDg4LTRjMzQtOGQxNy1lZDhmY2Y1OTdhOTQiLCJpYXQiOjE2MwerY2ODA4NzgsImlzcyI6InRva2VuLWVtaXR0ZXIiLCJqdGkiOiJmYTI0YWJiOC03Y2E5LTQ3NjUtYmYzNC1kMmvU5YTgzYjYxZmUifQ.23rn-2dEdAAYXJX2exrxDEdbieyKWsVKABeSUNeFWyhz7xRd7d5EcxwiMLjM3bRaBOKrAA9Op7ocn89c45qQ' \\ \n\n4\n\n--header 'Accept: application/json' \\ \n\n5\n\n--header 'Content-Type: application/json' \n\n`\n\n> ️ According to the [W3C definition of Message Headers in HTTP requests](https://read.calvincode.net/reader?url=https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html%23sec4.2), header names are case-insensitive. `X-VTEX-API-AppKey`, `x-vtex-api-appkey` or any other variation in the authentication headers will work the same way.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/authentication/api-authentication-using-api-keys.md)\n\n[Authentication« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys//docs/guides/authentication)[Rotating VTEX API tokensNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys//docs/guides/rotating-vtex-api-tokens)\n\nSee also\n\n[App authentication using auth tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/app-authentication-using-auth-tokens)[API authentication using user tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/api-authentication-using-user-tokens)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys/docs/guides/api-authentication-using-api-keys%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/Getting-Started/authentication/api-authentication-using-api-keys.md)\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/api-authentication-using-api-keys/docs/guides/api-authentication-using-api-keys%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=)"
}
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.